Documentation Guides Framework Community API Reference

Sign In Sign Up

novuhq/novu

37.2K

Getting Started

Overview Rate Limiting

Events

Trigger event POST Bulk trigger event POST Cancel triggered event DELETE Broadcast event to all POST

Subscribers

Create subscriber POST Patch subscriber PATCH Delete subscriber DELETE Get subscriber GET Search for subscribers GET Get subscriber preferences GET Update subscriber global or workflow specific preferences PATCH Bulk create subscribers POST Update subscriber credentials PUT Modify subscriber credentials PATCH Get in-app notification feed for a particular subscriber GET Get the unseen in-app notifications count for subscribers feed GET Mark message action as seen 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

Notifications

Get notification graph statistics GET Get notification statistics GET Get notification GET Get notifications GET

Topics

Subscribers addition POST Topic creation POST Delete topic DELETE Get topic GET Check topic subscriber GET Get topic list filtered GET Subscribers removal POST Rename a topic PATCH

Messages

Delete message DELETE Delete messages by transactionId DELETE Get messages GET

Integrations

Create integration POST Get active integrations GET Get webhook support status for provider GET Get integrations GET Delete integration DELETE Set integration as primary POST Update integration PUT

Documentation Guides Framework Community API Reference

Sign In Sign Up

novuhq/novu

37.2K

Get topic list filtered

Returns a list of topics that can be paginated using the `page` query parameter and filtered by the topic key with the `key` query parameter

Check topic subscriber GET

Check if a subscriber belongs to a certain topic

Subscribers removal POST

Remove subscribers from a topic