Novu API

Novu API

API version: 3.14.0

Auth

ApiKey Authorization in header

Base URL

https://api.novu.co

Setup

1. Set your API key in the appropriate header
2. GET /v1/environments -- verify access
3. POST /v1/environments -- create first environments

Endpoints

95 endpoints across 14 groups. See references/api-spec.lap for full details.

environments

events

notifications

integrations

contexts

subscribers

layouts

messages

topics

workflows

channel-connections

channel-endpoints

translations

inbound-webhooks

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "Create a environment?" -> POST /v1/environments
• "List all environments?" -> GET /v1/environments
• "Update a environment?" -> PUT /v1/environments/{environmentId}
• "Delete a environment?" -> DELETE /v1/environments/{environmentId}
• "Create a trigger?" -> POST /v1/events/trigger
• "Create a bulk?" -> POST /v1/events/trigger/bulk
• "Create a broadcast?" -> POST /v1/events/trigger/broadcast
• "Delete a trigger?" -> DELETE /v1/events/trigger/{transactionId}
• "Search notifications?" -> GET /v1/notifications
• "Get notification details?" -> GET /v1/notifications/{notificationId}
• "List all integrations?" -> GET /v1/integrations
• "Create a integration?" -> POST /v1/integrations
• "List all active?" -> GET /v1/integrations/active
• "Update a integration?" -> PUT /v1/integrations/{integrationId}
• "Delete a integration?" -> DELETE /v1/integrations/{integrationId}
• "Create a auto-configure?" -> POST /v1/integrations/{integrationId}/auto-configure
• "Create a set-primary?" -> POST /v1/integrations/{integrationId}/set-primary
• "Create a oauth?" -> POST /v1/integrations/chat/oauth
• "Create a context?" -> POST /v2/contexts
• "Search contexts?" -> GET /v2/contexts
• "Partially update a context?" -> PATCH /v2/contexts/{type}/{id}
• "Get context details?" -> GET /v2/contexts/{type}/{id}
• "Delete a context?" -> DELETE /v2/contexts/{type}/{id}
• "Create a bulk?" -> POST /v1/subscribers/bulk
• "Delete a credential?" -> DELETE /v1/subscribers/{subscriberId}/credentials/{providerId}
• "List all feed?" -> GET /v1/subscribers/{subscriberId}/notifications/feed
• "List all unseen?" -> GET /v1/subscribers/{subscriberId}/notifications/unseen
• "Create a mark-a?" -> POST /v1/subscribers/{subscriberId}/messages/mark-as
• "Create a mark-all?" -> POST /v1/subscribers/{subscriberId}/messages/mark-all
• "List all subscribers?" -> GET /v2/subscribers
• "Create a subscriber?" -> POST /v2/subscribers
• "Get subscriber details?" -> GET /v2/subscribers/{subscriberId}
• "Partially update a subscriber?" -> PATCH /v2/subscribers/{subscriberId}
• "Delete a subscriber?" -> DELETE /v2/subscribers/{subscriberId}
• "List all preferences?" -> GET /v2/subscribers/{subscriberId}/preferences
• "List all subscriptions?" -> GET /v2/subscribers/{subscriberId}/subscriptions
• "Create a layout?" -> POST /v2/layouts
• "Search layouts?" -> GET /v2/layouts
• "Update a layout?" -> PUT /v2/layouts/{layoutId}
• "Get layout details?" -> GET /v2/layouts/{layoutId}
• "Delete a layout?" -> DELETE /v2/layouts/{layoutId}
• "Create a duplicate?" -> POST /v2/layouts/{layoutId}/duplicate
• "Create a preview?" -> POST /v2/layouts/{layoutId}/preview
• "List all usage?" -> GET /v2/layouts/{layoutId}/usage
• "List all messages?" -> GET /v1/messages
• "Delete a message?" -> DELETE /v1/messages/{messageId}
• "Delete a transaction?" -> DELETE /v1/messages/transaction/{transactionId}
• "Get subscriber details?" -> GET /v1/topics/{topicKey}/subscribers/{externalSubscriberId}
• "List all topics?" -> GET /v2/topics
• "Create a topic?" -> POST /v2/topics
• "Get topic details?" -> GET /v2/topics/{topicKey}
• "Partially update a topic?" -> PATCH /v2/topics/{topicKey}
• "Delete a topic?" -> DELETE /v2/topics/{topicKey}
• "List all subscriptions?" -> GET /v2/topics/{topicKey}/subscriptions
• "Create a subscription?" -> POST /v2/topics/{topicKey}/subscriptions
• "Get subscription details?" -> GET /v2/topics/{topicKey}/subscriptions/{identifier}
• "Partially update a subscription?" -> PATCH /v2/topics/{topicKey}/subscriptions/{identifier}
• "Create a workflow?" -> POST /v2/workflows
• "Search workflows?" -> GET /v2/workflows
• "Update a workflow?" -> PUT /v2/workflows/{workflowId}
• "Get workflow details?" -> GET /v2/workflows/{workflowId}
• "Delete a workflow?" -> DELETE /v2/workflows/{workflowId}
• "Partially update a workflow?" -> PATCH /v2/workflows/{workflowId}
• "Get step details?" -> GET /v2/workflows/{workflowId}/steps/{stepId}
• "List all tags?" -> GET /v2/environments/{environmentId}/tags
• "Create a publish?" -> POST /v2/environments/{targetEnvironmentId}/publish
• "Create a diff?" -> POST /v2/environments/{targetEnvironmentId}/diff
• "List all channel-connections?" -> GET /v1/channel-connections
• "Create a channel-connection?" -> POST /v1/channel-connections
• "Get channel-connection details?" -> GET /v1/channel-connections/{identifier}
• "Partially update a channel-connection?" -> PATCH /v1/channel-connections/{identifier}
• "Delete a channel-connection?" -> DELETE /v1/channel-connections/{identifier}
• "List all channel-endpoints?" -> GET /v1/channel-endpoints
• "Create a channel-endpoint?" -> POST /v1/channel-endpoints
• "Get channel-endpoint details?" -> GET /v1/channel-endpoints/{identifier}
• "Partially update a channel-endpoint?" -> PATCH /v1/channel-endpoints/{identifier}
• "Delete a channel-endpoint?" -> DELETE /v1/channel-endpoints/{identifier}
• "Create a upload?" -> POST /v2/translations/upload
• "Create a translation?" -> POST /v2/translations
• "List all master-json?" -> GET /v2/translations/master-json
• "Create a master-json?" -> POST /v2/translations/master-json
• "Create a upload?" -> POST /v2/translations/master-json/upload
• "Get group details?" -> GET /v2/translations/group/{resourceType}/{resourceId}
• "Get translation details?" -> GET /v2/translations/{resourceType}/{resourceId}/{locale}
• "Delete a translation?" -> DELETE /v2/translations/{resourceType}/{resourceId}/{locale}
• "Delete a translation?" -> DELETE /v2/translations/{resourceType}/{resourceId}
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP