Skip to main content
GET
Retrieve a Custom Action

Usage

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

custom_integration_uid
string
required

The UID of the Custom Integration

uid
string
required

The UID of the Custom Action

Response

Successful

uid
string
read-only

The UID of the Custom Action

custom_integration_uid
string
read-only

The UID of the Custom Integration the action belongs to

name
string

The Custom Action name, unique within its Custom Integration (case-insensitive)

description
string | null

What the action does. Shown to admins and used by AI agents to decide when to run it.

context
enum<string>

The record the action runs on: request, user, app_access_request, or none. It decides which {{variable}} interpolations are available in the URL, headers and body.

Available options:
app_access_request,
none,
request,
user
enabled
boolean

Whether the action can be executed

interactive_mode
enum<string>

How the action is offered to agents in the Siit UI: disabled (not offered), no_inputs (run in one click), static_inputs (form described by interactive_input_definition), or dynamic_inputs (form fetched from interactive_input_definition_url at run time)

Available options:
disabled,
dynamic_inputs,
no_inputs,
static_inputs
interactive_input_definition_url
string | null

HTTPS URL returning the form to display. Required when interactive_mode is dynamic_inputs; cleared otherwise.

interactive_input_definition
(Enum field · object | Scalar field · object)[] | null

The form to display. Required when interactive_mode is static_inputs; cleared otherwise.

workflow_input_definition
(Enum field · object | Scalar field · object)[] | null

Inputs Workflows provide when running the action. null keeps the action out of Workflows; an empty array offers it to Workflows without inputs.

submit_url
string

HTTPS URL Siit calls when the action runs. Supports {{variable}} interpolation.

http_method
enum<string>

HTTP method used to call submit_url. A get action cannot declare inputs nor a body.

Available options:
get,
post,
put,
patch,
delete
custom_headers
object[]

Extra HTTP headers sent with the request, on top of the Custom Integration ones

body
string | null

Request body template. Supports {{variable}} interpolation. When empty, Siit sends a JSON object of the input values keyed by slug; use {{variable}} interpolation in a custom body to send context fields.

output_definition
(Enum output · object | Scalar output · object)[]

Values extracted from your endpoint JSON response, reusable in later Workflow steps

created_at
string<date-time>
read-only

datetime formatted as ISO 8601 (e.g. "2020-12-15T03:34:13.000Z")

updated_at
string<date-time>
read-only

datetime formatted as ISO 8601 (e.g. "2020-12-15T03:34:13.000Z")