Body
application/json
Response
Created
API Reference
Notifications
Integrations
Subscribers
- GETGet subscribers
- POSTBulk create subscribers
- PUTUpdate subscriber credentials
- PATCHModify subscriber credentials
- DELDelete subscriber credentials by providerId
- PATCHUpdate subscriber online status
- GETGet in-app notification feed for a particular subscriber
- GETGet the unseen in-app notifications count for subscribers feed
- POSTMark a subscriber messages as seen, read, unseen or unread
- 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
- GETSearch for subscribers
- POSTCreate subscriber
- GETGet subscriber
- DELDelete subscriber
- PATCHPatch subscriber
- GETGet subscriber preferences
- PATCHUpdate subscriber global or workflow specific preferences
Bulk trigger event
Copy
curl --request POST \
--url https://api.novu.co/v1/events/trigger/bulk \
--header 'Content-Type: application/json' \
--data '{
"events": [
{
"name": "<string>",
"payload": {
"comment_id": "string",
"post": {
"text": "string"
}
},
"overrides": {
"fcm": {
"data": {
"key": "value"
}
}
},
"to": {
"subscriberId": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>",
"avatar": "<string>",
"locale": "<string>",
"data": {}
},
"transactionId": "<string>",
"actor": "<string>",
"tenant": "<string>"
}
]
}'Copy
{
"data": [
{
"acknowledged": true,
"status": "error",
"error": [
"<string>"
],
"transactionId": "<string>"
}
]
}Events
Bulk trigger event
Using this endpoint you can trigger multiple events at once, to avoid multiple calls to the API. The bulk API is limited to 100 events per request.
POST
/
v1
/
events
/
trigger
/
bulk
Bulk trigger event
Copy
curl --request POST \
--url https://api.novu.co/v1/events/trigger/bulk \
--header 'Content-Type: application/json' \
--data '{
"events": [
{
"name": "<string>",
"payload": {
"comment_id": "string",
"post": {
"text": "string"
}
},
"overrides": {
"fcm": {
"data": {
"key": "value"
}
}
},
"to": {
"subscriberId": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>",
"avatar": "<string>",
"locale": "<string>",
"data": {}
},
"transactionId": "<string>",
"actor": "<string>",
"tenant": "<string>"
}
]
}'Copy
{
"data": [
{
"acknowledged": true,
"status": "error",
"error": [
"<string>"
],
"transactionId": "<string>"
}
]
}Was this page helpful?
Assistant
Responses are generated using AI and may contain mistakes.