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

Node.js

import { Novu } from "@novu/node";

const novu = new Novu("<NOVU_SECRET_KEY>");

await novu.trigger("<WORKFLOW_TRIGGER_IDENTIFIER>", {
  to: {
    subscriberId: "<UNIQUE_SUBSCRIBER_IDENTIFIER>",
    email: "[e-mail]",
    firstName: "John",
    lastName: "Doe",
  },
  payload: {
    name: "Hello World",
    organization: {
      logo: "https://happycorp.com/logo.png",
    },
  },
});

Response

{
  "data": {
    "acknowledged": true,
    "status": "processed",
    "transactionId": "string"
  }
}

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

Response

201

application/json

Created

The response is of type object.