API Reference
Subscribers
- GETGet subscribers
- POSTCreate subscriber
- POSTBulk create subscribers
- GETGet subscriber
- PUTUpdate subscriber
- DELDelete subscriber
- PUTUpdate subscriber credentials
- DELDelete subscriber credentials by providerid
- PATCHUpdate subscriber online status
- GETGet subscriber preferences
- GETGet subscriber global preferences
- PATCHUpdate subscriber preference
- PATCHUpdate subscriber global preference
- GETGet in app notification feed for a particular subscriber
- GETGet the unseen in app notifications count for subscribers feed
- POSTMark a subscriber feed message as seen
- POSTMarks all the subscriber messages as read unread seen or unseen optionally you can pass feed id or array to mark messages of a particular feed
- POSTMark message action as seen
- GETHandle providers oauth redirect
- GETHandle chat oauth
Topics
Notification
Workflows
Workflow Overrides
Workflow groups
Integrations
Layouts
Execution Details
Organizations
Events
Broadcast event to all
POST
https://api.novu.co
/
v1
/
events
/
trigger
/
broadcast
import { Novu } from '@novu/node';
const novu = new Novu("<NOVU_API_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_API_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"
}
}
Body
application/json
Response
200
application/json
Ok
The response is of type object
.
Was this page helpful?
import { Novu } from '@novu/node';
const novu = new Novu("<NOVU_API_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"
}
}
Assistant
Responses are generated using AI and may contain mistakes.