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. Only integration metadata is returned, credentials field is returned as an empty object.
Request body
The name of the integration
The unique identifier for the integration
The ID of the associated environment
The provider ID for the integration
The channel type for the integration. Not required for agent-kind integrations.
Distinguishes delivery integrations from agent-runtime integrations. Defaults to "delivery". Agent integrations do not require a channel.
If the integration is active, the validation on the credentials field will run
Flag to check the integration status
Configurations for the integration
Response
Created
The unique identifier of the integration record in the database. This is automatically generated.
The unique identifier for the environment associated with this integration. This links to the Environment collection.
The unique identifier for the organization that owns this integration. This links to the Organization collection.
The name of the integration, which is used to identify it in the user interface.
A unique string identifier for the integration, often used for API calls or internal references.
The identifier for the provider of the integration (e.g., "mailgun", "twilio").
The channel type for the integration, which defines how it communicates (e.g., email, SMS). Not set for agent-kind integrations.
Distinguishes delivery integrations from agent-runtime integrations. Defaults to "delivery". Agent integrations do not have a channel.
Indicates whether the integration is currently active. An active integration will process events and messages.
Indicates whether the integration has been marked as deleted (soft delete).
The timestamp indicating when the integration was deleted. This is set when the integration is soft deleted.
The identifier of the user who performed the deletion of this integration. Useful for audit trails.
Indicates whether this integration is marked as primary. A primary integration is often the default choice for processing.