Create integration
Create an integration for the current environment the user is based on the API key provided
Authorization
Authorization
<token>API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
In: header
Request Body
application/json
Requiredname
stringThe name of the integration
identifier
stringThe unique identifier for the integration
_environmentId
stringThe ID of the associated environment
"uuid"
providerId
RequiredstringThe provider ID for the integration
channel
RequiredstringThe channel type for the integration
"in_app" | "email" | "sms" | "chat" | "push"
credentials
objectThe credentials for the integration
active
booleanIf the integration is active, the validation on the credentials field will run
check
booleanFlag to check the integration status
conditions
array<object>Conditions for the integration
Header Parameters
idempotency-key
stringA header for idempotency purposes
Response Body
Created
_id
stringThe unique identifier of the integration record in the database. This is automatically generated.
_environmentId
RequiredstringThe unique identifier for the environment associated with this integration. This links to the Environment collection.
_organizationId
RequiredstringThe unique identifier for the organization that owns this integration. This links to the Organization collection.
name
RequiredstringThe name of the integration, which is used to identify it in the user interface.
identifier
RequiredstringA unique string identifier for the integration, often used for API calls or internal references.
providerId
RequiredstringThe identifier for the provider of the integration (e.g., "mailgun", "twilio").
channel
RequiredstringThe channel type for the integration, which defines how the integration communicates (e.g., email, SMS).
"in_app" | "email" | "sms" | "chat" | "push"
credentials
RequiredobjectThe credentials required for the integration to function, including API keys and other sensitive information.
active
RequiredbooleanIndicates whether the integration is currently active. An active integration will process events and messages.
deleted
RequiredbooleanIndicates whether the integration has been marked as deleted (soft delete).
deletedAt
stringThe timestamp indicating when the integration was deleted. This is set when the integration is soft deleted.
deletedBy
stringThe identifier of the user who performed the deletion of this integration. Useful for audit trails.
primary
RequiredbooleanIndicates whether this integration is marked as primary. A primary integration is often the default choice for processing.
conditions
array<object>An array of conditions associated with the integration that may influence its behavior or processing logic.
@minItems 0
@minItems 0