Novu home page
v2.x
Search or ask...
Blog
Contact us
Try Novu
Try Novu
Search...
Navigation
Topics
Check topic subscriber
Platform
<Inbox />
Framework
Community
API Reference
API Reference
API Overview
API Rate Limiting
Events
POST
Trigger event
POST
Bulk trigger event
POST
Broadcast event to all
DEL
Cancel triggered event
Notifications
GET
Get notifications
GET
Get notification statistics
GET
Get notification graph statistics
GET
Get notification
Integrations
GET
Get integrations
POST
Create integration
GET
Get active integrations
GET
Get webhook support status for provider
PUT
Update integration
DEL
Delete integration
POST
Set integration as primary
Subscribers
GET
Get subscribers
POST
Bulk create subscribers
PUT
Update subscriber credentials
PATCH
Modify subscriber credentials
DEL
Delete subscriber credentials by providerId
PATCH
Update subscriber online status
GET
Get in-app notification feed for a particular subscriber
GET
Get the unseen in-app notifications count for subscribers feed
POST
Mark a subscriber messages as seen, read, unseen or unread
POST
Marks 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.
POST
Mark message action as seen
GET
Handle providers oauth redirect
GET
Handle chat oauth
GET
Search for subscribers
POST
Create subscriber
GET
Get subscriber
DEL
Delete subscriber
PATCH
Patch subscriber
GET
Get subscriber preferences
PATCH
Update subscriber global or workflow specific preferences
Messages
GET
Get messages
DEL
Delete message
DEL
Delete messages by transactionId
Topics
GET
Get topic list filtered
POST
Topic creation
POST
Subscribers addition
GET
Check topic subscriber
POST
Subscribers removal
GET
Get topic
DEL
Delete topic
PATCH
Rename a topic
Topics
Check topic subscriber
Check if a subscriber belongs to a certain topic
GET
/
v1
/
topics
/
{topicKey}
/
subscribers
/
{externalSubscriberId}
Try it
Path Parameters
topicKey
string
required
externalSubscriberId
string
required
Response
200
200
409
429
503
application/json
_organizationId
string
required
_environmentId
string
required
_subscriberId
string
required
_topicId
string
required
topicKey
string
required
externalSubscriberId
string
required
Was this page helpful?
Yes
No
Suggest edits
Raise issue
Subscribers addition
Subscribers removal