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 19 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.1.0, at version 3.15.0.
Requests are made against 2 base URLs: https://api.novu.co, https://eu.api.novu.co.
Metadata
The identity and technical contract details declared by the specification.
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 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…
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.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Novu 12
Other APIs Novu publishes across the network.