Create integration

Create an integration for the current environment the user is based on the API key provided

Enter your API key in the Authorization field like the example shown below:

E.g ApiKey 18d2e625f05d80e

Authorizations

Authorization

string

header

required

API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".

Body

application/json

channel

enum<string>

required

The channel type for the integration

Available options:

in_app,

email,

sms,

chat,

push

providerId

string

required

The provider ID for the integration

_environmentId

string

The ID of the associated environment

active

boolean

If the integration is active, the validation on the credentials field will run

check

boolean

Flag to check the integration status

conditions

object[]

Conditions for the integration

Show child attributes

conditions.children

object[]

required

Show child attributes

conditions.children.field

string

required

conditions.children.on

enum<string>

required

Available options:

subscriber,

payload

conditions.children.operator

enum<string>

required

Available options:

LARGER,

SMALLER,

LARGER_EQUAL,

SMALLER_EQUAL,

EQUAL,

NOT_EQUAL,

ALL_IN,

ANY_IN,

NOT_IN,

BETWEEN,

NOT_BETWEEN,

LIKE,

NOT_LIKE,

IN

conditions.children.value

string

required

conditions.isNegated

boolean

required

conditions.type

enum<string>

required

Available options:

BOOLEAN,

TEXT,

DATE,

NUMBER,

STATEMENT,

LIST,

MULTI_LIST,

GROUP

conditions.value

enum<string>

required

Available options:

AND,

OR

credentials

object

The credentials for the integration

Show child attributes

credentials.accessKey

string

credentials.accountSid

string

credentials.alertUid

string

credentials.apiKey

string

credentials.apiKeyRequestHeader

string

credentials.apiToken

string

credentials.applicationId

string

credentials.authenticateByToken

boolean

credentials.authenticationTokenKey

string

credentials.baseUrl

string

credentials.channelId

string

credentials.clientId

string

credentials.datePath

string

credentials.domain

string

credentials.externalLink

string

credentials.from

string

credentials.hmac

boolean

credentials.host

string

credentials.idPath

string

credentials.ignoreTls

boolean

credentials.imageUrl

string

credentials.instanceId

string

credentials.ipPoolName

string

credentials.messageProfileId

string

credentials.password

string

credentials.phoneNumberIdentification

string

credentials.port

string

credentials.projectName

string

credentials.redirectUrl

string

credentials.region

string

credentials.requireTls

boolean

credentials.secretKey

string

credentials.secretKeyRequestHeader

string

credentials.secure

boolean

credentials.senderName

string

credentials.serviceAccount

string

credentials.state

string

credentials.title

string

credentials.tlsOptions

object

credentials.token

string

credentials.user

string

credentials.webhookUrl

string

identifier

string

The unique identifier for the integration

name

string

The name of the integration

Response

201 - application/json

data

object

Show child attributes

data._environmentId

string

required

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

data._organizationId

string

required

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

data.active

boolean

required

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

data.channel

enum<string>

required

The channel type for the integration, which defines how the integration communicates (e.g., email, SMS).

Available options:

in_app,

email,

sms,

chat,

push

data.credentials

object

required

The credentials required for the integration to function, including API keys and other sensitive information.

Show child attributes

data.credentials.accessKey

string

data.credentials.accountSid

string

data.credentials.alertUid

string

data.credentials.apiKey

string

data.credentials.apiKeyRequestHeader

string

data.credentials.apiToken

string

data.credentials.applicationId

string

data.credentials.authenticateByToken

boolean

data.credentials.authenticationTokenKey

string

data.credentials.baseUrl

string

data.credentials.channelId

string

data.credentials.clientId

string

data.credentials.datePath

string

data.credentials.domain

string

data.credentials.externalLink

string

data.credentials.from

string

data.credentials.hmac

boolean

data.credentials.host

string

data.credentials.idPath

string

data.credentials.ignoreTls

boolean

data.credentials.imageUrl

string

data.credentials.instanceId

string

data.credentials.ipPoolName

string

data.credentials.messageProfileId

string

data.credentials.password

string

data.credentials.phoneNumberIdentification

string

data.credentials.port

string

data.credentials.projectName

string

data.credentials.redirectUrl

string

data.credentials.region

string

data.credentials.requireTls

boolean

data.credentials.secretKey

string

data.credentials.secretKeyRequestHeader

string

data.credentials.secure

boolean

data.credentials.senderName

string

data.credentials.serviceAccount

string

data.credentials.state

string

data.credentials.title

string

data.credentials.tlsOptions

object

data.credentials.token

string

data.credentials.user

string

data.credentials.webhookUrl

string

data.deleted

boolean

required

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

data.identifier

string

required

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

data.name

string

required

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

data.primary

boolean

required

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

data.providerId

string

required

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

data._id

string

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

data.conditions

object[]

An array of conditions associated with the integration that may influence its behavior or processing logic.

Show child attributes

data.conditions.children

object[]

required

Show child attributes

data.conditions.children.field

string

required

data.conditions.children.on

enum<string>

required

Available options:

subscriber,

payload

data.conditions.children.operator

enum<string>

required

Available options:

LARGER,

SMALLER,

LARGER_EQUAL,

SMALLER_EQUAL,

EQUAL,

NOT_EQUAL,

ALL_IN,

ANY_IN,

NOT_IN,

BETWEEN,

NOT_BETWEEN,

LIKE,

NOT_LIKE,

IN

data.conditions.children.value

string

required

data.conditions.isNegated

boolean

required

data.conditions.type

enum<string>

required

Available options:

BOOLEAN,

TEXT,

DATE,

NUMBER,

STATEMENT,

LIST,

MULTI_LIST,

GROUP

data.conditions.value

enum<string>

required

Available options:

AND,

OR

data.deletedAt

string

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

data.deletedBy

string

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