Bulk trigger event

Using this endpoint you can trigger multiple events at once, to avoid multiple calls to the API. The bulk API is limited to 100 events per request.

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

events

object[]

required

Show child attributes

events.name

string

required

The trigger identifier of the workflow you wish to send. This identifier can be found on the workflow page.

events.to

required

The recipients list of people who will receive the notification.

Show child attributes

events.to.subscriberId

string

required

The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems

events.to.avatar

string

An HTTP URL to the profile image of your subscriber.

events.to.channels

object[]

An optional array of subscriber channels.

Show child attributes

events.to.channels.credentials

object

required

Credentials for the channel.

Show child attributes

events.to.channels.credentials.deviceTokens

string[]

An array of device tokens for push notifications.

events.to.channels.credentials.webhookUrl

string

The URL for the webhook associated with the channel.

events.to.channels.providerId

enum<string>

required

The ID of the chat or push provider.

Available options:

slack,

discord,

msteams,

mattermost,

ryver,

zulip,

grafana-on-call,

getstream,

rocket-chat,

whatsapp-business,

fcm,

apns,

expo,

one-signal,

pushpad,

push-webhook,

pusher-beams

events.to.channels.integrationIdentifier

string

An optional identifier for the integration.

events.to.data

object

An optional payload object that can contain any properties.

Show child attributes

events.to.data.{key}

events.to.email

string

The email address of the subscriber.

events.to.firstName

string

The first name of the subscriber.

events.to.lastName

string

The last name of the subscriber.

events.to.locale

string

The locale of the subscriber.

events.to.phone

string

The phone number of the subscriber.

events.actor

It is used to display the Avatar of the provided actor's subscriber id or actor object. If a new actor object is provided, we will create a new subscriber in our system

events.bridgeUrl

string

A URL to bridge for additional processing.

events.controls

object

Additional control configurations.

Show child attributes

events.controls.steps

object

A mapping of step IDs to their corresponding data.

Show child attributes

events.controls.steps.{key}

object

events.overrides

object

This could be used to override provider specific configurations

Show child attributes

events.overrides.{key}

object

events.payload

object

The payload object is used to pass additional custom information that could be used to render the workflow, or perform routing rules based on it. This data will also be available when fetching the notifications feed from the API to display certain parts of the UI.

events.tenant

It is used to specify a tenant context during trigger event. Existing tenants will be updated with the provided details.

events.transactionId

string

A unique identifier for this transaction, we will generate a UUID if not provided.

Response

201 - application/json

data

object[]

Show child attributes

data.acknowledged

boolean

required

Indicates whether the trigger was acknowledged or not

data.status

enum<string>

required

Status of the trigger

Available options:

error,

trigger_not_active,

no_workflow_active_steps_defined,

no_workflow_steps_defined,

processed,

subscriber_id_missing,

no_tenant_found

data.error

string[]

In case of an error, this field will contain the error message(s)

data.transactionId

string

The returned transaction ID of the trigger