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
Topics
Get topic
Get a topic by its topic key
GET
/
v1
/
topics
/
{topicKey}
curl --request GET \
--url https://api.novu.co/v1/topics/{topicKey}{
"data": {
"_id": "<string>",
"_organizationId": "<string>",
"_environmentId": "<string>",
"key": "<string>",
"name": "<string>",
"subscribers": [
"<string>"
]
}
}Path Parameters
Was this page helpful?
curl --request GET \
--url https://api.novu.co/v1/topics/{topicKey}{
"data": {
"_id": "<string>",
"_organizationId": "<string>",
"_environmentId": "<string>",
"key": "<string>",
"name": "<string>",
"subscribers": [
"<string>"
]
}
}