Novu home page
v0.23.0
Search...
⌘K
Ask AI
Get API Key
novuhq/novu
novuhq/novu
Search...
Navigation
API Reference
Documentation
API Reference
Learn by Videos
Get instant help
FAQs
API Reference
API Overview
API Rate Limiting
Events
POST
Trigger event
POST
Bulk trigger event
POST
Broadcast event to all
DEL
Cancel triggered event
Subscribers
GET
Get subscribers
POST
Create subscriber
POST
Bulk create subscribers
GET
Get subscriber
PUT
Update subscriber
DEL
Delete subscriber
PUT
Update subscriber credentials
DEL
Delete subscriber credentials by providerid
PATCH
Update subscriber online status
GET
Get subscriber preferences
GET
Get subscriber global preferences
PATCH
Update subscriber preference
PATCH
Update subscriber global preference
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 feed message 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
Mark message action as seen
GET
Handle providers oauth redirect
GET
Handle chat oauth
Topics
GET
Filter topics
POST
Topic creation
POST
Subscribers addition
GET
Check topic subscriber
POST
Subscribers removal
GET
Get topic
DEL
Delete topic
PATCH
Rename a topic
Notification
GET
Get notifications
GET
Get notification statistics
GET
Get notification graph statistics
GET
Get notification
Workflows
GET
Get workflows
POST
Create workflow
GET
Get workflow
PUT
Update workflow
DEL
Delete workflow
PUT
Update workflow status
Workflow Overrides
POST
Create workflow overrides
GET
Get workflow overrides
GET
Get workflow override
GET
Get workflow override by id
PUT
Update workflow override by id
PUT
Update workflow override
DEL
Delete workflow override
Workflow groups
GET
Get workflow groups
POST
Create workflow group
GET
Get workflow group
DEL
Delete workflow group
PATCH
Update workflow group
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
Layouts
GET
Filter layouts
POST
Layout creation
GET
Get layout
DEL
Delete layout
PATCH
Update a layout
POST
Set default layout
Inbound Parse
GET
Validate the mx record setup for the inbound parse functionality
Environments
GET
Get current environment
GET
Get environments
GET
Get api keys
POST
Regenerate api keys
Changes
GET
Get changes
GET
Get changes count
POST
Apply changes
POST
Apply change
Execution Details
GET
Get execution details
Feeds
GET
Get feeds
POST
Create feed
DEL
Delete feed
Tenants
GET
Get tenants
POST
Create tenant
GET
Get tenant
PATCH
Update tenant
DEL
Delete tenant
Organizations
POST
Create organization
GET
Get all organizations
GET
Get all members of current organization
GET
Get current organization
PATCH
Rename organization
PUT
Update member role to admin
PUT
Update organization branding
DEL
Delete member from organization
Messages
GET
Get messages
DEL
Delete message
DEL
Delete message by transactionid
Blueprints
GET
Get v1blueprintsgroup by category
GET
Get v1blueprints
Organizations
Update member role to admin
Enter your API key in the
Authorization
field like the example shown below:
E.g
ApiKey 18d2e625f05d80e
Was this page helpful?
Yes
No
Suggest edits
Raise issue
Rename organization
Update organization branding
Assistant
Responses are generated using AI and may contain mistakes.