Trigger event

Trigger event is the main (and only) way to send notifications to subscribers. The trigger identifier is used to match the particular workflow associated with it. Additional information can be passed according the body interface below.

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

E.g ApiKey 18d2e625f05d80e

Idempotent nature of transactionId

The transactionId within Novu is a unique identifier that is used to ensure the idempotent nature of notification delivery.

When you trigger an event to send a notification, you have the option to provide a transactionId. If you do not provide one, Novu will generate a UUID for you.

This identifier is particularly useful for preventing the same notification from being sent multiple times in case the trigger event is inadvertently called more than once.

By leveraging the transactionId, you can make idempotent requests, which means if the same transactionId is used in another request, Novu’s API will recognize it and will not send the same notification again.

This upholds the principle of idempotency, ensuring that the effect of the operation is the same, no matter how many times the request is repeated with the same transactionId.

Authorizations

Authorization

string

header

required

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

Body

application/json

name

string

required

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

to

required

The recipients list of people who will receive the notification.

Show child attributes

to.subscriberId

string

required

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

to.avatar

string

An HTTP URL to the profile image of your subscriber.

to.channels

object[]

An optional array of subscriber channels.

Show child attributes

to.channels.credentials

object

required

Credentials for the channel.

Show child attributes

to.channels.credentials.deviceTokens

string[]

An array of device tokens for push notifications.

to.channels.credentials.webhookUrl

string

The URL for the webhook associated with the channel.

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

to.channels.integrationIdentifier

string

An optional identifier for the integration.

to.data

object

An optional payload object that can contain any properties.

Show child attributes

to.data.{key}

to.email

string

The email address of the subscriber.

to.firstName

string

The first name of the subscriber.

to.lastName

string

The last name of the subscriber.

to.locale

string

The locale of the subscriber.

to.phone

string

The phone number of the subscriber.

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

bridgeUrl

string

A URL to bridge for additional processing.

controls

object

Additional control configurations.

Show child attributes

controls.steps

object

A mapping of step IDs to their corresponding data.

Show child attributes

controls.steps.{key}

object

overrides

object

This could be used to override provider specific configurations

Show child attributes

overrides.{key}

object

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.

tenant

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

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