Novu home page
v0.23.0
Search...
⌘K
Get API Key
novuhq/novu
novuhq/novu
Search...
Navigation
API Reference
Documentation
API Reference
Learn by Videos
Get Instant Help
Help Center
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 preferences by level
PATCH
Update subscriber preference
PATCH
Update subscriber global preferences
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 messages as seen or as read
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 override
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 an organization
GET
Fetch all organizations
GET
Fetch all members of current organizations
GET
Fetch current organization details
PATCH
Rename organization name
PUT
Update member role to admin
PUT
Update organization branding details
DEL
Remove a member from organization using memberId
Messages
GET
Get messages
DEL
Delete message
DEL
Delete messages by transactionId
Blueprints
GET
Get v1blueprintsgroup by category
GET
Get v1blueprints
Blueprints
Get v1blueprints
Was this page helpful?
Yes
No
Suggest edits
Raise issue
Get v1blueprintsgroup by category
Assistant
Responses are generated using AI and may contain mistakes.