Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Novu Subscribers API

Manage notification recipients and their credentials.

Novu Subscribers API is one of 13 APIs that Novu publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Subscribers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 6 operations across 4 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

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

6 operations 4 paths 3 schemas 1 DELETE1 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.novu.co/v1
Authentication
API Key
Contact
License
Resource Areas
1

Authentication & Security 1

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

  • apiKeyAuth — Novu secret API key from the Dashboard API Keys page, sent as Authorization: ApiKey .

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 1 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Subscribers 6

Manage notification recipients and their credentials.

POST
/subscribers
Create a subscriber
createSubscriber body → 201401
POST
/subscribers/bulk
Bulk create subscribers
bulkCreateSubscribers body → 201401
GET
/subscribers/{subscriberId}
Retrieve a subscriber
getSubscriber 1 param → 200404
PUT
/subscribers/{subscriberId}
Update a subscriber
updateSubscriber 1 param body → 200404
DELETE
/subscribers/{subscriberId}
Delete a subscriber
deleteSubscriber 1 param → 200404
PUT
/subscribers/{subscriberId}/credentials/{providerId}
Update provider credentials
updateSubscriberCredentials 2 params body → 200404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are SubscriberInput (8 properties), Error (3 properties). Each schema is shown below with its type and property counts.

Error
object
3 properties
Subscriber
SubscriberInput
object
8 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

novu-co-subscribers-api-openapi.yml Raw ↑

Other APIs Novu publishes across the network.

Novu Inbox Realtime API
Novu Environments API
Novu Events API
Novu Inbox API
Novu Integrations API
Novu Layouts API
Novu Messages API
Novu Notifications API
Novu Preferences API
Novu Topics API
Novu Translations API
Novu Workflows API