| Field | Type | Required | Description |
|---|---|---|---|
id |
Optional<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 |
IntegrationResponseDtoChannel | ✔️ | The channel type for the integration, which defines how it communicates (e.g., email, SMS). |
credentials |
CredentialsDto | ✔️ | The credentials required for the integration to function, including API keys and other sensitive information. |
configurations |
Optional<ConfigurationsDto> | ➖ | The configurations required for enabling the additional configurations of the integration. |
active |
boolean | ✔️ | Indicates whether the integration is currently active. An active integration will process events and messages. |
deleted |
boolean | ✔️ | Indicates whether the integration has been marked as deleted (soft delete). |
deletedAt |
Optional<String> | ➖ | The timestamp indicating when the integration was deleted. This is set when the integration is soft deleted. |
deletedBy |
Optional<String> | ➖ | The identifier of the user who performed the deletion of this integration. Useful for audit trails. |
primary |
boolean | ✔️ | Indicates whether this integration is marked as primary. A primary integration is often the default choice for processing. |
conditions |
List<StepFilterDto> | ➖ | An array of conditions associated with the integration that may influence its behavior or processing logic. |