Create a Custom Action
Create a Custom Action calling submit_url with the integration secret and headers. Actions are created disabled unless enabled is true. Set interactive_mode to offer the action to agents on records of its context, and workflow_input_definition to offer it to Workflows. The role of the token owner must be allowed to configure integrations.
POST
/
v1
/
custom_integrations
/
{custom_integration_uid}
/
custom_actions
Create a Custom Action
curl --request POST \
--url https://api.siit.io/v1/custom_integrations/{custom_integration_uid}/custom_actions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"context": "none",
"enabled": false,
"interactive_mode": "disabled",
"interactive_input_definition_url": "<string>",
"interactive_input_definition": [
{
"slug": "<string>",
"label": "<string>",
"kind": "enum",
"values": [
"<string>"
],
"required": false,
"multiple": false
}
],
"workflow_input_definition": [
{
"slug": "<string>",
"label": "<string>",
"kind": "enum",
"values": [
"<string>"
],
"required": false,
"multiple": false
}
],
"submit_url": "<string>",
"http_method": "post",
"custom_headers": [
{
"name": "<string>",
"value": "<string>"
}
],
"body": "<string>",
"output_definition": []
}
'import requests
url = "https://api.siit.io/v1/custom_integrations/{custom_integration_uid}/custom_actions"
payload = {
"name": "<string>",
"description": "<string>",
"context": "none",
"enabled": False,
"interactive_mode": "disabled",
"interactive_input_definition_url": "<string>",
"interactive_input_definition": [
{
"slug": "<string>",
"label": "<string>",
"kind": "enum",
"values": ["<string>"],
"required": False,
"multiple": False
}
],
"workflow_input_definition": [
{
"slug": "<string>",
"label": "<string>",
"kind": "enum",
"values": ["<string>"],
"required": False,
"multiple": False
}
],
"submit_url": "<string>",
"http_method": "post",
"custom_headers": [
{
"name": "<string>",
"value": "<string>"
}
],
"body": "<string>",
"output_definition": []
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
context: 'none',
enabled: false,
interactive_mode: 'disabled',
interactive_input_definition_url: '<string>',
interactive_input_definition: [
{
slug: '<string>',
label: '<string>',
kind: 'enum',
values: ['<string>'],
required: false,
multiple: false
}
],
workflow_input_definition: [
{
slug: '<string>',
label: '<string>',
kind: 'enum',
values: ['<string>'],
required: false,
multiple: false
}
],
submit_url: '<string>',
http_method: 'post',
custom_headers: [{name: '<string>', value: '<string>'}],
body: JSON.stringify('<string>'),
output_definition: []
})
};
fetch('https://api.siit.io/v1/custom_integrations/{custom_integration_uid}/custom_actions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.siit.io/v1/custom_integrations/{custom_integration_uid}/custom_actions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'context' => 'none',
'enabled' => false,
'interactive_mode' => 'disabled',
'interactive_input_definition_url' => '<string>',
'interactive_input_definition' => [
[
'slug' => '<string>',
'label' => '<string>',
'kind' => 'enum',
'values' => [
'<string>'
],
'required' => false,
'multiple' => false
]
],
'workflow_input_definition' => [
[
'slug' => '<string>',
'label' => '<string>',
'kind' => 'enum',
'values' => [
'<string>'
],
'required' => false,
'multiple' => false
]
],
'submit_url' => '<string>',
'http_method' => 'post',
'custom_headers' => [
[
'name' => '<string>',
'value' => '<string>'
]
],
'body' => '<string>',
'output_definition' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.siit.io/v1/custom_integrations/{custom_integration_uid}/custom_actions"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"context\": \"none\",\n \"enabled\": false,\n \"interactive_mode\": \"disabled\",\n \"interactive_input_definition_url\": \"<string>\",\n \"interactive_input_definition\": [\n {\n \"slug\": \"<string>\",\n \"label\": \"<string>\",\n \"kind\": \"enum\",\n \"values\": [\n \"<string>\"\n ],\n \"required\": false,\n \"multiple\": false\n }\n ],\n \"workflow_input_definition\": [\n {\n \"slug\": \"<string>\",\n \"label\": \"<string>\",\n \"kind\": \"enum\",\n \"values\": [\n \"<string>\"\n ],\n \"required\": false,\n \"multiple\": false\n }\n ],\n \"submit_url\": \"<string>\",\n \"http_method\": \"post\",\n \"custom_headers\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"body\": \"<string>\",\n \"output_definition\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.siit.io/v1/custom_integrations/{custom_integration_uid}/custom_actions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"context\": \"none\",\n \"enabled\": false,\n \"interactive_mode\": \"disabled\",\n \"interactive_input_definition_url\": \"<string>\",\n \"interactive_input_definition\": [\n {\n \"slug\": \"<string>\",\n \"label\": \"<string>\",\n \"kind\": \"enum\",\n \"values\": [\n \"<string>\"\n ],\n \"required\": false,\n \"multiple\": false\n }\n ],\n \"workflow_input_definition\": [\n {\n \"slug\": \"<string>\",\n \"label\": \"<string>\",\n \"kind\": \"enum\",\n \"values\": [\n \"<string>\"\n ],\n \"required\": false,\n \"multiple\": false\n }\n ],\n \"submit_url\": \"<string>\",\n \"http_method\": \"post\",\n \"custom_headers\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"body\": \"<string>\",\n \"output_definition\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.siit.io/v1/custom_integrations/{custom_integration_uid}/custom_actions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"context\": \"none\",\n \"enabled\": false,\n \"interactive_mode\": \"disabled\",\n \"interactive_input_definition_url\": \"<string>\",\n \"interactive_input_definition\": [\n {\n \"slug\": \"<string>\",\n \"label\": \"<string>\",\n \"kind\": \"enum\",\n \"values\": [\n \"<string>\"\n ],\n \"required\": false,\n \"multiple\": false\n }\n ],\n \"workflow_input_definition\": [\n {\n \"slug\": \"<string>\",\n \"label\": \"<string>\",\n \"kind\": \"enum\",\n \"values\": [\n \"<string>\"\n ],\n \"required\": false,\n \"multiple\": false\n }\n ],\n \"submit_url\": \"<string>\",\n \"http_method\": \"post\",\n \"custom_headers\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"body\": \"<string>\",\n \"output_definition\": []\n}"
response = http.request(request)
puts response.read_body{
"result": {
"uid": "<string>",
"custom_integration_uid": "<string>",
"name": "<string>",
"description": "<string>",
"context": "app_access_request",
"enabled": true,
"interactive_mode": "disabled",
"interactive_input_definition_url": "<string>",
"interactive_input_definition": [
{
"slug": "<string>",
"label": "<string>",
"kind": "enum",
"values": [
"<string>"
],
"required": false,
"multiple": false
}
],
"workflow_input_definition": [
{
"slug": "<string>",
"label": "<string>",
"kind": "enum",
"values": [
"<string>"
],
"required": false,
"multiple": false
}
],
"submit_url": "<string>",
"http_method": "get",
"custom_headers": [
{
"name": "<string>",
"value": "<string>"
}
],
"body": "<string>",
"output_definition": [
{
"slug": "<string>",
"kind": "enum",
"values": [
"<string>"
]
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>",
"troubleshoot": "<string>"
}{
"error": "<string>",
"troubleshoot": "<string>"
}Usage
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The UID of the Custom Integration
Body
application/json
On update, only the provided attributes change; custom_headers replaces the whole list. Send workflow_input_definition: null to remove the action from Workflows, and an empty body to restore the default payload.
The Custom Action name, unique within its Custom Integration (case-insensitive)
Maximum string length:
100What the action does. Shown to admins and used by AI agents to decide when to run it.
Maximum string length:
1000The 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 Whether the action can be executed
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 HTTPS URL returning the form to display. Required when interactive_mode is dynamic_inputs; cleared otherwise.
Maximum string length:
2048The form to display. Required when interactive_mode is static_inputs; cleared otherwise.
- Enum field
- Scalar field
Show child attributes
Show child attributes
Inputs Workflows provide when running the action. null keeps the action out of Workflows; an empty array offers it to Workflows without inputs.
- Enum field
- Scalar field
Show child attributes
Show child attributes
HTTPS URL Siit calls when the action runs. Supports {{variable}} interpolation.
Maximum string length:
2048HTTP method used to call submit_url. A get action cannot declare inputs nor a body. Case-insensitive.
Available options:
get, post, put, patch, delete Extra HTTP headers sent with the request, on top of the Custom Integration ones
Show child attributes
Show child attributes
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.
Maximum string length:
100000Values extracted from your endpoint JSON response, reusable in later Workflow steps
- Enum output
- Scalar output
Show child attributes
Show child attributes
Response
Custom Action created
Show child attributes
Show child attributes
Create a Custom Action
curl --request POST \
--url https://api.siit.io/v1/custom_integrations/{custom_integration_uid}/custom_actions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"context": "none",
"enabled": false,
"interactive_mode": "disabled",
"interactive_input_definition_url": "<string>",
"interactive_input_definition": [
{
"slug": "<string>",
"label": "<string>",
"kind": "enum",
"values": [
"<string>"
],
"required": false,
"multiple": false
}
],
"workflow_input_definition": [
{
"slug": "<string>",
"label": "<string>",
"kind": "enum",
"values": [
"<string>"
],
"required": false,
"multiple": false
}
],
"submit_url": "<string>",
"http_method": "post",
"custom_headers": [
{
"name": "<string>",
"value": "<string>"
}
],
"body": "<string>",
"output_definition": []
}
'import requests
url = "https://api.siit.io/v1/custom_integrations/{custom_integration_uid}/custom_actions"
payload = {
"name": "<string>",
"description": "<string>",
"context": "none",
"enabled": False,
"interactive_mode": "disabled",
"interactive_input_definition_url": "<string>",
"interactive_input_definition": [
{
"slug": "<string>",
"label": "<string>",
"kind": "enum",
"values": ["<string>"],
"required": False,
"multiple": False
}
],
"workflow_input_definition": [
{
"slug": "<string>",
"label": "<string>",
"kind": "enum",
"values": ["<string>"],
"required": False,
"multiple": False
}
],
"submit_url": "<string>",
"http_method": "post",
"custom_headers": [
{
"name": "<string>",
"value": "<string>"
}
],
"body": "<string>",
"output_definition": []
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
context: 'none',
enabled: false,
interactive_mode: 'disabled',
interactive_input_definition_url: '<string>',
interactive_input_definition: [
{
slug: '<string>',
label: '<string>',
kind: 'enum',
values: ['<string>'],
required: false,
multiple: false
}
],
workflow_input_definition: [
{
slug: '<string>',
label: '<string>',
kind: 'enum',
values: ['<string>'],
required: false,
multiple: false
}
],
submit_url: '<string>',
http_method: 'post',
custom_headers: [{name: '<string>', value: '<string>'}],
body: JSON.stringify('<string>'),
output_definition: []
})
};
fetch('https://api.siit.io/v1/custom_integrations/{custom_integration_uid}/custom_actions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.siit.io/v1/custom_integrations/{custom_integration_uid}/custom_actions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'context' => 'none',
'enabled' => false,
'interactive_mode' => 'disabled',
'interactive_input_definition_url' => '<string>',
'interactive_input_definition' => [
[
'slug' => '<string>',
'label' => '<string>',
'kind' => 'enum',
'values' => [
'<string>'
],
'required' => false,
'multiple' => false
]
],
'workflow_input_definition' => [
[
'slug' => '<string>',
'label' => '<string>',
'kind' => 'enum',
'values' => [
'<string>'
],
'required' => false,
'multiple' => false
]
],
'submit_url' => '<string>',
'http_method' => 'post',
'custom_headers' => [
[
'name' => '<string>',
'value' => '<string>'
]
],
'body' => '<string>',
'output_definition' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.siit.io/v1/custom_integrations/{custom_integration_uid}/custom_actions"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"context\": \"none\",\n \"enabled\": false,\n \"interactive_mode\": \"disabled\",\n \"interactive_input_definition_url\": \"<string>\",\n \"interactive_input_definition\": [\n {\n \"slug\": \"<string>\",\n \"label\": \"<string>\",\n \"kind\": \"enum\",\n \"values\": [\n \"<string>\"\n ],\n \"required\": false,\n \"multiple\": false\n }\n ],\n \"workflow_input_definition\": [\n {\n \"slug\": \"<string>\",\n \"label\": \"<string>\",\n \"kind\": \"enum\",\n \"values\": [\n \"<string>\"\n ],\n \"required\": false,\n \"multiple\": false\n }\n ],\n \"submit_url\": \"<string>\",\n \"http_method\": \"post\",\n \"custom_headers\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"body\": \"<string>\",\n \"output_definition\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.siit.io/v1/custom_integrations/{custom_integration_uid}/custom_actions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"context\": \"none\",\n \"enabled\": false,\n \"interactive_mode\": \"disabled\",\n \"interactive_input_definition_url\": \"<string>\",\n \"interactive_input_definition\": [\n {\n \"slug\": \"<string>\",\n \"label\": \"<string>\",\n \"kind\": \"enum\",\n \"values\": [\n \"<string>\"\n ],\n \"required\": false,\n \"multiple\": false\n }\n ],\n \"workflow_input_definition\": [\n {\n \"slug\": \"<string>\",\n \"label\": \"<string>\",\n \"kind\": \"enum\",\n \"values\": [\n \"<string>\"\n ],\n \"required\": false,\n \"multiple\": false\n }\n ],\n \"submit_url\": \"<string>\",\n \"http_method\": \"post\",\n \"custom_headers\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"body\": \"<string>\",\n \"output_definition\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.siit.io/v1/custom_integrations/{custom_integration_uid}/custom_actions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"context\": \"none\",\n \"enabled\": false,\n \"interactive_mode\": \"disabled\",\n \"interactive_input_definition_url\": \"<string>\",\n \"interactive_input_definition\": [\n {\n \"slug\": \"<string>\",\n \"label\": \"<string>\",\n \"kind\": \"enum\",\n \"values\": [\n \"<string>\"\n ],\n \"required\": false,\n \"multiple\": false\n }\n ],\n \"workflow_input_definition\": [\n {\n \"slug\": \"<string>\",\n \"label\": \"<string>\",\n \"kind\": \"enum\",\n \"values\": [\n \"<string>\"\n ],\n \"required\": false,\n \"multiple\": false\n }\n ],\n \"submit_url\": \"<string>\",\n \"http_method\": \"post\",\n \"custom_headers\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"body\": \"<string>\",\n \"output_definition\": []\n}"
response = http.request(request)
puts response.read_body{
"result": {
"uid": "<string>",
"custom_integration_uid": "<string>",
"name": "<string>",
"description": "<string>",
"context": "app_access_request",
"enabled": true,
"interactive_mode": "disabled",
"interactive_input_definition_url": "<string>",
"interactive_input_definition": [
{
"slug": "<string>",
"label": "<string>",
"kind": "enum",
"values": [
"<string>"
],
"required": false,
"multiple": false
}
],
"workflow_input_definition": [
{
"slug": "<string>",
"label": "<string>",
"kind": "enum",
"values": [
"<string>"
],
"required": false,
"multiple": false
}
],
"submit_url": "<string>",
"http_method": "get",
"custom_headers": [
{
"name": "<string>",
"value": "<string>"
}
],
"body": "<string>",
"output_definition": [
{
"slug": "<string>",
"kind": "enum",
"values": [
"<string>"
]
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>",
"troubleshoot": "<string>"
}{
"error": "<string>",
"troubleshoot": "<string>"
}