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 Inbox / In-App API

Client-side API and React Inbox component for rendering an embedded in-app notification center, marking notifications as read / archived / snoozed, and managing per-user notification preferences directly in the browser. Ships with @novu/react, @novu/react-native, and @novu/js (vanilla) packages, plus pre-built Notion / Linear / Novu themes and full headless API access.

Novu Inbox / In-App API is one of 19 APIs that Novu publishes on the APIs.io network, described by an AsyncAPI event-driven specification.

Tagged areas include In App, Inbox, React, React Native, and Client SDK. The published artifact set on APIs.io includes API documentation, an AsyncAPI specification, a getting-started guide, and code examples.

This event API exposes 1 operation across 1 channel, and defines 8 schemas. It is described by AsyncAPI 2.6.0, at version 1.0.0.

The API connects through 4 servers: wss://ws.novu.co (wss), wss://eu.ws.novu.co (wss), wss://dev.ws.novu.co (wss), {scheme}://{host}:{port} (wss).

1 operations 1 channels 8 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
1.0.0
Base URL
https://api.novu.co
Contact
License
Resource Areas
1

Channels & Operations 1

Across 1 channel, the API surfaces 1 operation. Each is listed below with its action, channel, parameters, and response codes.

Channels 1
SUB
/
Receive real-time Notification Center events for the authenticated subscriber.
subscribeNotificationCenter body

Messages & Schemas 8

The contract defines 8 schemas that model the data carried by its messages. The most detailed are Message (31 properties), SubscriberJwtClaims (9 properties), UnreadCountChangedPayload (3 properties), UnseenCountChangedPayload (2 properties). Each schema is shown below with its type and property counts.

NotificationReceived
message
A new in-app notification was delivered to the authenticated subscriber's inbox.
UnreadCountChanged
message
The subscriber's unread in-app notification count changed.
UnseenCountChanged
message
The subscriber's unseen in-app notification count changed.
NotificationReceivedPayload
object
Payload of a notificationreceived Socket.IO event. Carries the full Message entity that the React Inbox component renders as a new row. When the queued WS job…
1 property 1 required
UnreadCountChangedPayload
object
Payload of an unreadcountchanged Socket.IO event.
3 properties 3 required
UnseenCountChangedPayload
object
Payload of an unseencountchanged Socket.IO event.
2 properties 2 required
Message
object
Novu in-app Message entity as persisted by @novu/dal and serialized over the WS connection. This is the same shape returned by GET /v1/inbox/notifications on t…
31 properties
SubscriberJwtClaims
object
Decoded payload of the Subscriber JWT supplied in the Socket.IO handshake (auth.token / query.token). Issued by POST /v1/widgets/session. The WS gateway reject…
9 properties 5 required

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

novu-asyncapi.yml Raw ↑

Other APIs Novu publishes across the network.

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
Novu Layouts API