Novu

Novu Topics API

Topics are a way to group subscribers together so that they can be notified of events at once. A topic is identified by a custom key. This can be helpful for things like sending out marketing emails or notifying users of new features. Topics can also be used to send notifications to the subscribers who have been grouped together based on their interests, location, activities and much more.

Documentation GitHub OpenAPI

Operations 11

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/topics/{topicKey}/subscribers/{externalSubscriberId} Check if a subscriber is in a topic · Novu Check Topic Subscriber #

Ask an LLM

“Is a particular subscriber part of a given topic?”

“How can I confirm someone is already subscribed to a topic before adding them?”

Tell an agent

Check whether subscriber {externalSubscriberId} belongs to topic {topicKey}.

Confirm {externalSubscriberId} is a member of the {topicKey} topic.

GET /v2/topics List topics · Novu List All Topics #

Ask an LLM

“What topics have I set up for group notifications?”

“Can I filter my topics by key or by name?”

Tell an agent

List all topics.

Find topics named {name}.

POST /v2/topics Create or update a topic · Novu Create a Topic #

Ask an LLM

“How do I create a topic to notify a group of subscribers together?”

“What happens if I create a topic whose key already exists?”

Tell an agent

Create a topic with key {key} and name {name}.

Create topic {key} but fail if it already exists: {failIfExists}.

GET /v2/topics/{topicKey} Get a topic · Novu Retrieve a Topic #

Ask an LLM

“How do I look up a topic by its key?”

“What name is set on a specific topic?”

Tell an agent

Show me topic {topicKey}.

Retrieve the details of the {topicKey} topic.

PATCH /v2/topics/{topicKey} Rename a topic · Novu Update a Topic #

Ask an LLM

“How do I change the display name of an existing topic?”

“Can I rename a topic without changing its key?”

Tell an agent

Rename topic {topicKey} to {name}.

Change the name of existing topic {topicKey} to {name}.

DELETE /v2/topics/{topicKey} Delete a topic · Novu Delete a Topic #

Ask an LLM

“What happens to a topic's subscriptions when I delete it?”

“Can I permanently remove a topic by its key?”

Tell an agent destructive · confirm first

Delete topic {topicKey} and all its subscriptions.

Permanently remove the {topicKey} topic.

GET /v2/topics/{topicKey}/subscriptions List a topic's subscribers · Novu List Topic Subscriptions #

Ask an LLM

“Who is subscribed to a given topic?”

“Can I page through every subscription in a large topic?”

Tell an agent

List the subscriptions for topic {topicKey}.

Show the subscription for {subscriberId} within topic {topicKey}'s subscriber list.

POST /v2/topics/{topicKey}/subscriptions Subscribe subscribers to a topic · Novu Create Topic Subscriptions #

Ask an LLM

“How do I add several subscribers to a topic at once?”

“Does subscribing people to a topic that doesn't exist yet create it?”

Tell an agent

Subscribe {subscriberIds} to topic {topicKey}.

Add {subscriberIds} to topic {topicKey} with preferences {preferences}.

DELETE /v2/topics/{topicKey}/subscriptions Unsubscribe subscribers from a topic · Novu Delete Topic Subscriptions #

Ask an LLM

“How do I remove a few subscribers from a topic while keeping the topic?”

“Can I unsubscribe multiple people from a topic in one call?”

Tell an agent destructive · confirm first

Unsubscribe {subscriberIds} from topic {topicKey}.

Remove subscriptions {subscriptions} from topic {topicKey}.

GET /v2/topics/{topicKey}/subscriptions/{identifier} Get a topic subscription · Novu Retrieve a Topic Subscription #

Ask an LLM

“How do I look up one subscription in a topic by its identifier?”

“What preferences are stored on a specific topic subscription?”

Tell an agent

Show subscription {identifier} in topic {topicKey}.

Fetch the preferences on topic {topicKey} subscription {identifier}.

PATCH /v2/topics/{topicKey}/subscriptions/{identifier} Update a topic subscription · Novu Update a Topic Subscription #

Ask an LLM

“How do I change the preferences on someone's topic subscription?”

“Can I rename a single subscription within a topic?”

Tell an agent

Update preferences on subscription {identifier} in topic {topicKey} to {preferences}.

Rename subscription {identifier} of topic {topicKey} to {name}.

Novu Topics API

Operations 11

Documentation

Specifications

Code Examples

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification