How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.

Novu Topics API is one of 20 APIs that Novu publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 26 JSON Schema definitions.

Tagged areas include Topics. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, rate-limit docs, a getting-started guide, and 26 JSON Schemas.

This API exposes 11 operations across 5 paths, and defines 32 schemas. It is described by OpenAPI 3.2.0, at version 3.15.0.

Requests are made against 2 base URLs: https://api.novu.co, https://eu.api.novu.co.

11 operations 5 paths 32 schemas 2 DELETE5 GET2 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.15.0
Base URL
https://api.novu.co
Authentication
API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Novu Topics API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (secretKey). By default, every request must be authenticated.

  • secretKey — API key authentication. Allowed headers-- "Authorization: ApiKey ".

Paths & Operations 11

Across 5 paths, the API surfaces 11 operations — 2 DELETE, 5 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Topics 11

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 o…

GET
/v1/topics/{topicKey}/subscribers/{externalSubscriberId}
Novu Check Topic Subscriber
TopicsV1Controller_getTopicSubscriber 2 params → 200400401403404405409413
GET
/v2/topics
Novu List All Topics
TopicsController_listTopics 8 params → 200400401403404405409413
POST
/v2/topics
Novu Create a Topic
TopicsController_upsertTopic 1 param body → 200201400401403404405409
GET
/v2/topics/{topicKey}
Novu Retrieve a Topic
TopicsController_getTopic 1 param → 200400401403404405409413
PATCH
/v2/topics/{topicKey}
Novu Update a Topic
TopicsController_updateTopic 1 param body → 200400401403404405409413
DELETE
/v2/topics/{topicKey}
Novu Delete a Topic
TopicsController_deleteTopic 1 param → 200400401403404405409413
GET
/v2/topics/{topicKey}/subscriptions
Novu List Topic Subscriptions
TopicsController_listTopicSubscriptions 9 params → 200400401403404405409413
POST
/v2/topics/{topicKey}/subscriptions
Novu Create Topic Subscriptions
TopicsController_createTopicSubscriptions 1 param body → 201400401403404405409413
DELETE
/v2/topics/{topicKey}/subscriptions
Novu Delete Topic Subscriptions
TopicsController_deleteTopicSubscriptions 1 param body → 200400401403404405409413
GET
/v2/topics/{topicKey}/subscriptions/{identifier}
Novu Retrieve a Topic Subscription
TopicsController_getTopicSubscription 2 params → 200400401403404405409413
PATCH
/v2/topics/{topicKey}/subscriptions/{identifier}
Novu Update a Topic Subscription
TopicsController_updateTopicSubscription 2 params body → 200400401403404405409413

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are SubscriptionResponseDto (9 properties), SubscriptionDto (7 properties), WorkflowDto (7 properties), ValidationErrorDto (7 properties). Each schema is shown below with its type and property counts.

TopicDto
object
3 properties 2 required
SubscriptionDetailsResponseDto
object
5 properties 1 required
GroupPreferenceFilterDetailsDto
object
2 properties
DeleteTopicSubscriptionsRequestDto
object
2 properties
ListTopicSubscriptionsResponseDto
object
5 properties 5 required
DeleteTopicSubscriptionsResponseDto
object
3 properties 2 required
TopicSubscriberIdentifierDto
object
3 properties 2 required
CreateSubscriptionsResponseDto
object
3 properties 2 required
TopicSubscriptionResponseDto
object
6 properties 5 required
TopicSubscriberDto
object
6 properties 6 required
SubscriberDto
object
6 properties 2 required
WorkflowPreferenceRequestDto
object
3 properties 1 required
MetaDto
object
3 properties 3 required
ErrorDto
object
6 properties 3 required
ConstraintValidation
object
2 properties 1 required
GroupPreferenceFilterDto
object
3 properties 1 required
CreateTopicSubscriptionsRequestDto
object
5 properties
SubscriptionResponseDto
object
9 properties 5 required
ListTopicsResponseDto
object
5 properties 5 required
UpdateTopicSubscriptionRequestDto
object
2 properties
ValidationErrorDto
object
7 properties 4 required
WorkflowDto
object
7 properties 5 required
SubscriptionDto
object
7 properties 5 required
SeverityLevelEnum
string
Severity of the workflow
UpdateTopicRequestDto
object
1 property 1 required
SubscriptionErrorDto
object
3 properties 3 required
SubscriptionPreferenceDto
object
4 properties 2 required
SubscriptionsDeleteErrorDto
object
3 properties 3 required
CreateUpdateTopicRequestDto
object
2 properties 1 required
DeleteTopicSubscriberIdentifierDto
object
2 properties
TopicResponseDto
object
5 properties 2 required
DeleteTopicResponseDto
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

novu-topics-api-openapi.yml Raw ↑

Other APIs Novu publishes across the network.

Novu Inbox / In-App API
Novu Framework (Code-First Workflows)
Novu MCP Server
Novu Activity API
Novu Channel Connections API
Novu Channel Endpoints API
Novu Contexts API
Novu Domains API
Novu Environment Variables API
Novu Environments API
Novu Events API
Novu Integrations API
Where this information came from

This is an independent, third-party profile of Novu Topics API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.