POST
/
v1
/
events
/
trigger
/
broadcast
import { Novu } from "@novu/node";

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

await novu.events.broadcast("<WORKFLOW_TRIGGER_IDENTIFIER>", {
  payload: {
    customKey: "customValue",
    customKey1: {
      nestedkey1: "nestedValue1",
    },
  },
  overrides: {
    email: {
      from: "support@novu.co",
    },
  },
  tenant: "tenantIdentifier",
});

{
  "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.events.broadcast("<WORKFLOW_TRIGGER_IDENTIFIER>", {
  payload: {
    customKey: "customValue",
    customKey1: {
      nestedkey1: "nestedValue1",
    },
  },
  overrides: {
    email: {
      from: "support@novu.co",
    },
  },
  tenant: "tenantIdentifier",
});

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

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Response

200
application/json

Ok

The response is of type object.