Skip to main content
PUT
Update a Custom Integration

Usage

Authorizations

Authorization
string
header
required

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

Path Parameters

uid
string
required

The UID of the Custom Integration

Body

application/json

On update, only the provided attributes change; custom_headers replaces the whole list.

name
string

The Custom Integration name, unique within the company

Maximum string length: 100
api_doc_url
string<uri> | null

Link to the documentation of the API this integration calls

Maximum string length: 2048
access_token
string
write-only

The secret Siit sends to your API, as configured by auth_method. Required on creation, even with auth_method: none. Never returned.

auth_method
enum<string>
default:bearer_token

How the secret authenticates requests: bearer_token (Authorization: Bearer <secret>), api_key (<auth_header_name>: <secret>), basic_auth (Authorization: Basic base64(<auth_username>:<secret>)), or none

Available options:
api_key,
basic_auth,
bearer_token,
none
auth_header_name
string | null

Header carrying the secret. Required when auth_method is api_key.

Maximum string length: 255
auth_username
string | null

Username combined with the secret. Required when auth_method is basic_auth.

Maximum string length: 255
custom_headers
object[]

HTTP headers sent with every request of the integration Custom Actions

Response

200 - application/json

Successful

result
object