Trigger event

POST

events

trigger

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

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

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

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

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

E.g ApiKey 18d2e625f05d80e

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

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

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

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

Authorizations

Authorization

string

headerrequired

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.

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.

bridgeUrl

string

A URL to bridge for additional processing.

overrides

object

This could be used to override provider specific configurations

array

required

The recipients list of people who will receive the notification.

transactionId

string

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

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

tenant

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

controls

object

Additional control configurations.

Response

201 - application/json

data

object

Was this page helpful?

API Rate Limiting Bulk trigger event

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

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

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

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