Integrations

Integration management endpoints

List all integrations

get
Authorizations
AuthorizationstringRequired

API Key with rest-api:* scope

Responses
200

List of integrations

application/json
get
/integrations
200

List of integrations

Create a new integration

post
Authorizations
AuthorizationstringRequired

API Key with rest-api:* scope

Body
typestring · min: 1Required

Integration type (use /integrations/types to get available types)

namestring · min: 2 · max: 100Required
configobjectRequired

Configuration object (varies by type, validated by integration handler)

Responses
post
/integrations

Get available integration types

get
Authorizations
AuthorizationstringRequired

API Key with rest-api:* scope

Responses
200

List of integration types

application/json
get
/integrations/types
200

List of integration types

Get integration details

get
Authorizations
AuthorizationstringRequired

API Key with rest-api:* scope

Path parameters
integrationIdintegerRequired
Responses
200

Integration details

No content

get
/integrations/{integrationId}
200

Integration details

No content

Update integration

put
Authorizations
AuthorizationstringRequired

API Key with rest-api:* scope

Path parameters
integrationIdintegerRequired
Body
namestring · min: 2 · max: 100Optional
configobjectOptional

Configuration object (validated by integration handler)

is_activebooleanOptional
Responses
200

Integration updated

No content

put
/integrations/{integrationId}

No content

Delete integration

delete
Authorizations
AuthorizationstringRequired

API Key with rest-api:* scope

Path parameters
integrationIdintegerRequired
Responses
200

Integration deleted

No content

delete
/integrations/{integrationId}
200

Integration deleted

No content

Last updated