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

Novu home page

Platform
Agents
API Reference

Contact Us
Get Started

Novu home page

Getting Started

Overview
Authentication
Errors
Pagination
Rate Limiting
Idempotency
Payload Limits

Events

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

Subscribers

Subscriber schema
POST
Create a subscriber
GET
Retrieve a subscriber
PATCH
Update a subscriber
DEL
Delete a subscriber
GET
Search subscribers
GET
Retrieve subscriber subscriptions
POST
Bulk create subscribers
GET
Retrieve subscriber preferences
PATCH
Update subscriber preferences
PATCH
Bulk update subscriber preferences
PUT
Update provider credentials
PATCH
Upsert provider credentials
DEL
Delete provider credentials
GET
Retrieve subscriber notifications
POST
Update notifications state
POST
Update all notifications state
PATCH
Update subscriber online status
GET
Retrieve unseen notifications count
POST
Update notification action status

Inbox

GET
Retrieve subscriber notifications count
PATCH
Mark a notification as read
PATCH
Mark a notification as unread
POST
Mark all notifications as read
POST
Mark notifications as seen
PATCH
Snooze a notification
PATCH
Unsnooze a notification
PATCH
Archive a notification
PATCH
Unarchive a notification
POST
Archive all notifications
POST
Archive all read notifications
DEL
Delete a notification
POST
Delete all notifications
PATCH
Complete a notification action
PATCH
Revert a notification action

Topics

Topic schema
POST
Create a topic
GET
Retrieve a topic
PATCH
Update a topic
DEL
Delete a topic
GET
List all topics
POST
Create topic subscriptions
DEL
Delete topic subscriptions
PATCH
Update a topic subscription
GET
List topic subscriptions
GET
Check topic subscriber
GET
Retrieve a topic subscription

Notifications

Notification event schema
GET
List all events
GET
Retrieve an event

Workflows

Workflow schema
POST
Create a workflow
GET
Retrieve a workflow
PUT
Update a workflow
DEL
Delete a workflow
GET
List all workflows
PUT
Sync a workflow
GET
Retrieve workflow step
POST
Generate a step preview

Translations

POST
Create a translation
GET
Retrieve a translation
DEL
Delete a translation
GET
Retrieve a translation group
DEL
Delete a translation group
POST
Import master translations JSON
GET
Retrieve master translations JSON
POST
Upload master translations JSON file
POST
Upload translation files

Contexts

Context schema
POST
Create a context
GET
Retrieve a context
PATCH
Update a context
DEL
Delete a context
GET
List all contexts

Environments

Environment schema
POST
Create an environment
PUT
Update an environment
DEL
Delete an environment
GET
List all environments
GET
List environment tags
POST
Compare resources between environments
POST
Publish resources to target environment

Environment Variables

Environment variable schema
POST
Create a variable
GET
Retrieve a variable
PATCH
Update a variable
DEL
Delete a variable
GET
List all variables
GET
Retrieve a variable usage

Messages

Message schema
GET
List all messages
DEL
Delete a message
DEL
Delete messages by transactionId

Integrations

Integration schema
POST
Create an integration
PUT
Update an integration
DEL
Delete an integration
GET
List all integrations
GET
List active integrations
POST
Update integration as primary
POST
Generate chat OAuth URL
POST
Auto-configure an integration for inbound webhooks

Agents

Agent schema
POST
Create an agent
GET
List all agents
GET
Retrieve an agent
PATCH
Update an agent
DEL
Delete an agent
PUT
Update an agent bridge
POST
Send an agent reply
POST
Create an agent integration
GET
List agent integrations
PATCH
Update an agent integration
DEL
Delete an agent integration

Channel Connections

POST
Create a channel connection
GET
Retrieve a channel connection
PATCH
Update a channel connection
DEL
Delete a channel connection
GET
List all channel connections

Channel Endpoints

POST
Create a channel endpoint
GET
Retrieve a channel endpoint
PATCH
Update a channel endpoint
DEL
Delete a channel endpoint
GET
List all channel endpoints

Activity

POST
Track activity and engagement events

Layouts

POST
Create a layout
DEL
Delete a layout
POST
Duplicate a layout
POST
Generate layout preview
GET
Get layout usage
GET
List all layouts
GET
Retrieve a layout
PUT
Update a layout

Contexts

GET
List all contexts
POST
Create a context
GET
Retrieve a context
DEL
Delete a context
PATCH
Update a context

Environments

GET
List environment tags
POST
Compare resources between environments
POST
Publish resources to target environment
GET
List all environments
POST
Create an environment
PUT
Update an environment
DEL
Delete an environment

Activity

POST
Track provider activity and engagement events

Layouts

GET
List all layouts
POST
Create a layout
GET
Retrieve a layout
PUT
Update a layout
DEL
Delete a layout
POST
Duplicate a layout
POST
Generate layout preview
GET
Get layout usage

Subscribers

GET
Search subscribers
POST
Create a subscriber
GET
Retrieve a subscriber
DEL
Delete a subscriber
PATCH
Update a subscriber
GET
Retrieve subscriber notifications
DEL
Delete a notification
PATCH
Complete a notification action
PATCH
Revert a notification action
PATCH
Archive a notification
PATCH
Mark a notification as read
PATCH
Snooze a notification
PATCH
Unarchive a notification
PATCH
Mark a notification as unread
PATCH
Unsnooze a notification
POST
Archive all notifications
GET
Retrieve subscriber notifications count
POST
Delete all notifications
POST
Mark all notifications as read
POST
Archive all read notifications
POST
Mark notifications as seen
GET
Retrieve subscriber preferences
PATCH
Update subscriber preferences
PATCH
Bulk update subscriber preferences
GET
Retrieve subscriber subscriptions
PUT
Update provider credentials
PATCH
Upsert provider credentials
DEL
Delete provider credentials
POST
Update notification action status
POST
Update all notifications state
POST
Update notifications state
GET
Retrieve subscriber notifications
deprecated
GET
Retrieve unseen notifications count
PATCH
Update subscriber online status
POST
Bulk create subscribers

Topics

GET
List all topics
POST
Create a topic
GET
Retrieve a topic
DEL
Delete a topic
PATCH
Update a topic
GET
List topic subscriptions
POST
Create topic subscriptions
DEL
Delete topic subscriptions
GET
Retrieve a topic subscription
PATCH
Update a topic subscription
GET
Check topic subscriber

Translations

POST
Create a translation
DEL
Delete a translation group
GET
Retrieve a translation
DEL
Delete a translation
GET
Retrieve a translation group
GET
Retrieve master translations JSON
POST
Import master translations JSON
POST
Upload master translations JSON file
POST
Upload translation files

Workflows

GET
List all workflows
POST
Create a workflow
GET
Retrieve a workflow
PUT
Update a workflow
DEL
Delete a workflow
PATCH
Update a workflow
POST
Generate a step preview
GET
Retrieve workflow step
PUT
Sync a workflow

Channel Connections

GET
List all channel connections
POST
Create a channel connection
GET
Retrieve a channel connection
DEL
Delete a channel connection
PATCH
Update a channel connection

Channel Endpoints

GET
List all channel endpoints
POST
Create a channel endpoint
GET
Retrieve a channel endpoint
DEL
Delete a channel endpoint
PATCH
Update a channel endpoint

Domains

GET
List domains for an environment
POST
Create a domain
GET
Retrieve a domain by name
DEL
Delete a domain
PATCH
Update a domain
GET
Retrieve auto-configuration availability
POST
Start DNS auto-configuration
POST
Diagnose inbound DNS for a domain
GET
List routes for a domain
POST
Create a route
GET
Retrieve a route by address
DEL
Delete a route
PATCH
Update a route
POST
Test an inbound route
POST
Verify a domain

Environment Variables

GET
List all variables
POST
Create a variable
GET
Get environment variable
DEL
Delete environment variable
PATCH
Update a variable
GET
Retrieve a variable usage

Events

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

Integrations

GET
List all integrations
POST
Create an integration
PUT
Update an integration
DEL
Delete an integration
POST
Auto-configure an integration for inbound webhooks
POST
Update integration as primary
POST
Issue a short-lived mobile setup link for an existing integration
POST
Configure a chat integration webhook
GET
List active integrations
POST
Generate OAuth URL for a workspace/tenant connection
POST
Issue a URL to link a subscriber chat identity
POST
Generate OAuth URL to link a subscriber user identity
POST
Generate chat OAuth URL

Messages

GET
List all messages
DEL
Delete a message
DEL
Delete messages by transactionId

Notifications

GET
List all events
GET
Retrieve an event

Agents

Update an agent

Update an agent by its external identifier.

Was this page helpful?

Suggest edits Raise issue

Retrieve an agent

Novu home page

x github linkedin

Comparison

Novu vs Courier Novu vs Knock Novu vs MagicBell Novu vs SuprSend Novu vs In-house

Resources

Contact Support Changelog Roadmap Contact Sales Read llms.txt

x github linkedin

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

Assistant

Responses are generated using AI and may contain mistakes.

Contact support