Sign in
Integrations

Update integration as primary

Update an integration as primary by its unique key identifier integrationId. This API will set the integration as primary for that channel in the current environment. Primary integration is used to deliver notification for sms and email channels in the workflow. Only integration metadata is returned, credentials field is returned as an empty object.

post/v1/integrations/{integrationId}/set-primary

Path parameters

integrationIdstring required

Headers

idempotency-keystring

A header for idempotency purposes

Response

OK

_idstring

The unique identifier of the integration record in the database. This is automatically generated.

_environmentIdstring required

The unique identifier for the environment associated with this integration. This links to the Environment collection.

_organizationIdstring required

The unique identifier for the organization that owns this integration. This links to the Organization collection.

namestring required

The name of the integration, which is used to identify it in the user interface.

identifierstring required

A unique string identifier for the integration, often used for API calls or internal references.

providerIdstring required

The identifier for the provider of the integration (e.g., "mailgun", "twilio").

channel'in_app' | 'email' | 'sms' | 'chat' | 'push' | 'tool'

The channel type for the integration, which defines how it communicates (e.g., email, SMS). Not set for agent-kind integrations.

kind'delivery' | 'agent'

Distinguishes delivery integrations from agent-runtime integrations. Defaults to "delivery". Agent integrations do not have a channel.

activeboolean required

Indicates whether the integration is currently active. An active integration will process events and messages.

deletedboolean required

Indicates whether the integration has been marked as deleted (soft delete).

deletedAtstring

The timestamp indicating when the integration was deleted. This is set when the integration is soft deleted.

deletedBystring

The identifier of the user who performed the deletion of this integration. Useful for audit trails.

primaryboolean required

Indicates whether this integration is marked as primary. A primary integration is often the default choice for processing.

Changes

Changed in 4 of the 12 revisions of this API.14

  • 16a3452440981See the full diff
    • ○

      added the optional property credentials/allOf[CredentialsDto]/hmacSecretKeyEncoding to the response with the 200 status

      response-optional-property-added

  • c2b2fa0d5d481See the full diff
    • ○

      added the optional property credentials/allOf[CredentialsDto]/configurationSetName to the response with the 200 status

      response-optional-property-added

  • 8092e41edd571See the full diff
    • ○

      added the optional property configurations/allOf[ConfigurationsDto]/payloadSchema to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • c69777f6018411See the full diff
    • ●

      added the new tool enum value to the channel response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property credentials/allOf[CredentialsDto]/whatsNextCompletedAt to the response with the 200 status

      response-optional-property-added