Update a Custom Action

PUT

custom_integrations

{custom_integration_uid}

custom_actions

{uid}

Update a Custom Action

curl --request PUT \
  --url https://api.siit.io/v1/custom_integrations/{custom_integration_uid}/custom_actions/{uid} \
  --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/{uid}"

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.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  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/{uid}', 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/{uid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  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/{uid}"

	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("PUT", 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.put("https://api.siit.io/v1/custom_integrations/{custom_integration_uid}/custom_actions/{uid}")
  .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/{uid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.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"
  }
}

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

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.

name

string

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

Maximum string length: 100

description

string | null

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

Maximum string length: 1000

context

enum<string>

default:none

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

default:false

Whether the action can be executed

interactive_mode

enum<string>

default:disabled

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<uri> | null

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

Maximum string length: 2048

interactive_input_definition

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

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

Enum field
Scalar field

Show child attributes

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.

Enum field
Scalar field

Show child attributes

submit_url

string<uri>

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

Maximum string length: 2048

http_method

enum<string>

default:post

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

Available options:

get,

post,

put,

patch,

delete

custom_headers

object[]

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

Show child attributes

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.

Maximum string length: 100000

output_definition

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

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

Enum output
Scalar output

Show child attributes

Response

200 - application/json

Successful

result

object

Show child attributes

Update a Custom Action

curl --request PUT \
  --url https://api.siit.io/v1/custom_integrations/{custom_integration_uid}/custom_actions/{uid} \
  --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/{uid}"

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.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  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/{uid}', 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/{uid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  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/{uid}"

	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("PUT", 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.put("https://api.siit.io/v1/custom_integrations/{custom_integration_uid}/custom_actions/{uid}")
  .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/{uid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.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"
  }
}

Get Started

Application

App Access Role

Article

Company

Department

Equipment

Legal Entity

Office Location

Request

Approval

Request Tag

Service

Tag

Team

Team inbox

User

Workflow

Custom Integrations

Usage

Authorizations

Path Parameters

Body

Response

​Usage

Authorizations

Path Parameters

Body

Response

Usage