Create an integration
Create an integration for the current environment the user is based on the API key provided. Each provider supports different credentials, check the provider documentation for more details.
Authorization
Authorization<token>API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
In: header
Request Body
application/jsonRequirednamestringThe name of the integration
identifierstringThe unique identifier for the integration
_environmentIdstringThe ID of the associated environment
"uuid"providerIdRequiredstringThe provider ID for the integration
channelRequiredstringThe channel type for the integration
"in_app" | "email" | "sms" | "chat" | "push"credentialsobjectThe credentials for the integration
activebooleanIf the integration is active, the validation on the credentials field will run
checkbooleanFlag to check the integration status
conditionsarray<object>Conditions for the integration
configurationsobjectConfigurations for the integration
Header Parameters
idempotency-keystringA header for idempotency purposes
Response Body
Created
_idstringThe unique identifier of the integration record in the database. This is automatically generated.
_environmentIdRequiredstringThe unique identifier for the environment associated with this integration. This links to the Environment collection.
_organizationIdRequiredstringThe unique identifier for the organization that owns this integration. This links to the Organization collection.
nameRequiredstringThe name of the integration, which is used to identify it in the user interface.
identifierRequiredstringA unique string identifier for the integration, often used for API calls or internal references.
providerIdRequiredstringThe identifier for the provider of the integration (e.g., "mailgun", "twilio").
channelRequiredstringThe channel type for the integration, which defines how the integration communicates (e.g., email, SMS).
"in_app" | "email" | "sms" | "chat" | "push"credentialsRequiredobjectThe credentials required for the integration to function, including API keys and other sensitive information.
configurationsobjectThe configurations required for enabling the additional configurations of the integration.
activeRequiredbooleanIndicates whether the integration is currently active. An active integration will process events and messages.
deletedRequiredbooleanIndicates whether the integration has been marked as deleted (soft delete).
deletedAtstringThe timestamp indicating when the integration was deleted. This is set when the integration is soft deleted.
deletedBystringThe identifier of the user who performed the deletion of this integration. Useful for audit trails.
primaryRequiredbooleanIndicates whether this integration is marked as primary. A primary integration is often the default choice for processing.
conditionsarray<object>An array of conditions associated with the integration that may influence its behavior or processing logic.
@minItems 0