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
Events
Trigger event
Trigger event is the main (and only) way to send notifications to subscribers. The trigger identifier is used to match the particular workflow associated with it. Additional information can be passed according the body interface below.
POST
/
v1
/
events
/
trigger
Copy
curl --request POST \
--url https://api.novu.co/v1/events/trigger \
--header 'Content-Type: application/json' \
--data '{
"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>"
}
}Body
application/json
Response
201
application/json
Created
The response is of type object.
Was this page helpful?
Copy
curl --request POST \
--url https://api.novu.co/v1/events/trigger \
--header 'Content-Type: application/json' \
--data '{
"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>"
}
}Assistant
Responses are generated using AI and may contain mistakes.