CreateIntegrationRequestDto

May 13, 2026 ยท View on GitHub

Fields

FieldTypeRequiredDescription
nameOptional<String>:heavy_minus_sign:The name of the integration
identifierOptional<String>:heavy_minus_sign:The unique identifier for the integration
environmentIdOptional<String>:heavy_minus_sign:The ID of the associated environment
providerIdOptional<String>:heavy_minus_sign:The provider ID for the integration
channelOptional<CreateIntegrationRequestDtoChannel>:heavy_minus_sign:The channel type for the integration. Not required for agent-kind integrations.
kindOptional<CreateIntegrationRequestDtoKind>:heavy_minus_sign:Distinguishes delivery integrations from agent-runtime integrations. Defaults to "delivery". Agent integrations do not require a channel.
credentialsOptional<CredentialsDto>:heavy_minus_sign:The credentials for the integration
activeOptional<Boolean>:heavy_minus_sign:If the integration is active, the validation on the credentials field will run
checkOptional<Boolean>:heavy_minus_sign:Flag to check the integration status
conditionsList<StepFilterDto>:heavy_minus_sign:Conditions for the integration
configurationsOptional<CreateIntegrationRequestDtoConfigurations>:heavy_minus_sign:Configurations for the integration