Skip to content

Create integration

POST
/v1/integrations/

Create a new integration.

IntegrationCreate
object
integration_type
required
Integration Type
string
>= 1 characters <= 30 characters
provider_type
required
Provider Type
string
>= 1 characters <= 50 characters
status
Status
string
default: active <= 20 characters
settings
Settings
object
key
additional properties
any

Successful Response

IntegrationResponse
object
id
required
Id
string format: uuid
organization_id
required
Organization Id
string format: uuid
integration_type
required
Integration Type
string
provider_type
required
Provider Type
string
status
required
Status
string
settings
required
Settings
object
key
additional properties
any
last_sync_at
Any of:
string format: date-time
error_details
Any of:
object
key
additional properties
any
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time

Unauthorized

Integration with this provider already exists

Validation error