Broadcast event to all

Trigger a broadcast event to all existing subscribers, could be used to send announcements, etc. In the future could be used to trigger events to a subset of subscribers based on defined filters.

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.events.broadcast("<WORKFLOW_TRIGGER_IDENTIFIER>", {
  payload: {
    customKey: "customValue",
    customKey1: {
      nestedkey1: "nestedValue1",
    },
  },
  overrides: {
    email: {
      from: "[e-mail]",
    },
  },
  tenant: "tenantIdentifier",
});

Response

{
  "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.