| Field | Type | Required | Description |
|---|---|---|---|
ID |
*string | ➖ | The unique identifier of the integration record in the database. This is automatically generated. |
EnvironmentID |
string | ✔️ | The unique identifier for the environment associated with this integration. This links to the Environment collection. |
OrganizationID |
string | ✔️ | The unique identifier for the organization that owns this integration. This links to the Organization collection. |
Name |
string | ✔️ | The name of the integration, which is used to identify it in the user interface. |
Identifier |
string | ✔️ | A unique string identifier for the integration, often used for API calls or internal references. |
ProviderID |
string | ✔️ | The identifier for the provider of the integration (e.g., "mailgun", "twilio"). |
Channel |
components.IntegrationResponseDtoChannel | ✔️ | The channel type for the integration, which defines how the integration communicates (e.g., email, SMS). |
Credentials |
components.CredentialsDto | ✔️ | The credentials required for the integration to function, including API keys and other sensitive information. |
Active |
bool | ✔️ | Indicates whether the integration is currently active. An active integration will process events and messages. |
Deleted |
bool | ✔️ | Indicates whether the integration has been marked as deleted (soft delete). |
DeletedAt |
*string | ➖ | The timestamp indicating when the integration was deleted. This is set when the integration is soft deleted. |
DeletedBy |
*string | ➖ | The identifier of the user who performed the deletion of this integration. Useful for audit trails. |
Primary |
bool | ✔️ | Indicates whether this integration is marked as primary. A primary integration is often the default choice for processing. |
Conditions |
[]components.StepFilterDto | ➖ | An array of conditions associated with the integration that may influence its behavior or processing logic. |