IntegrationResponseDto

Fields

Field	Type	Required	Description
id	Optional<String>	:heavy_minus_sign:	The unique identifier of the integration record in the database. This is automatically generated.
environmentId	String	:heavy_check_mark:	The unique identifier for the environment associated with this integration. This links to the Environment collection.
organizationId	String	:heavy_check_mark:	The unique identifier for the organization that owns this integration. This links to the Organization collection.
name	String	:heavy_check_mark:	The name of the integration, which is used to identify it in the user interface.
identifier	String	:heavy_check_mark:	A unique string identifier for the integration, often used for API calls or internal references.
providerId	String	:heavy_check_mark:	The identifier for the provider of the integration (e.g., "mailgun", "twilio").
channel	Optional<IntegrationResponseDtoChannel>	:heavy_minus_sign:	The channel type for the integration, which defines how it communicates (e.g., email, SMS). Not set for agent-kind integrations.
kind	Optional<IntegrationResponseDtoKind>	:heavy_minus_sign:	Distinguishes delivery integrations from agent-runtime integrations. Defaults to "delivery". Agent integrations do not have a channel.
credentials	Optional<CredentialsDto>	:heavy_minus_sign:	The decrypted credentials required for the integration to function (e.g. provider API keys, signing secrets). Only returned to dashboard/session-token callers; API-key authenticated callers receive the integration metadata without this field to avoid amplifying API-key leaks into provider-credential leaks.
configurations	Optional<ConfigurationsDto>	:heavy_minus_sign:	The configurations required for enabling the additional configurations of the integration.
active	boolean	:heavy_check_mark:	Indicates whether the integration is currently active. An active integration will process events and messages.
deleted	boolean	:heavy_check_mark:	Indicates whether the integration has been marked as deleted (soft delete).
deletedAt	Optional<String>	:heavy_minus_sign:	The timestamp indicating when the integration was deleted. This is set when the integration is soft deleted.
deletedBy	Optional<String>	:heavy_minus_sign:	The identifier of the user who performed the deletion of this integration. Useful for audit trails.
primary	boolean	:heavy_check_mark:	Indicates whether this integration is marked as primary. A primary integration is often the default choice for processing.
conditions	List<StepFilterDto>	:heavy_minus_sign:	An array of conditions associated with the integration that may influence its behavior or processing logic.