Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.

Skip to main content

v2 Docs
Pricing
Blog
Contact us
novuhq/novu
novuhq/novu

Documentation
API Reference
Discord Support

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 provider credentials
DEL
Delete provider credentials
PATCH
Update subscriber online status
GET
Get subscriber preferences
GET
Get subscriber global preferences
PATCH
Update subscriber preference
PATCH
Update subscriber global preferences
GET
Retrieve subscriber notifications
GET
Retrieve unseen notifications count
POST
Mark a subscriber feed message as seen
POST
Update all notifications state
POST
Update notification action status
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
List all events
GET
Get notification statistics
GET
Get notification graph statistics
GET
Retrieve an event

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
List all integrations
POST
Create an integration
GET
List active integrations
GET
Get webhook support status for provider
PUT
Update an integration
DEL
Delete an integration
POST
Update 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
List all 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
List all messages
DEL
Delete a message
DEL
Delete messages by transactionId

Blueprints

GET
Get v1blueprintsgroup by category
GET
Get v1blueprints

Blueprints

Get v1blueprintsgroup by category

Enter your API key in the Authorization field like the example shown below:E.g ApiKey 18d2e625f05d80e

Was this page helpful?

Delete messages by transactionId

Get v1blueprints

twitter github linkedin

Powered byThis documentation is built and hosted on Mintlify, a developer documentation platform