Novu Inbox Realtime API
Real-time WebSocket (Socket.IO) surface that pushes live Inbox updates to browser and mobile clients - notification_received, unseen_count_changed, and unread_count_changed events - authenticated by subscriberId, applicationIdentifier, and an HMAC subscriber hash. Powers the embeddable Inbox component's live bell, counts, and feed.
Novu Inbox Realtime API is one of 13 APIs that Novu publishes on the APIs.io network, described by an AsyncAPI event-driven specification.
Tagged areas include WebSocket, Realtime, Inbox, and Socket.IO. The published artifact set on APIs.io includes API documentation and an AsyncAPI specification.
This event API exposes 3 operations across 3 channels, and defines 5 schemas. It is described by AsyncAPI 2.6.0, at version 1.0.0.
The API connects through 2 servers: ws.novu.co (wss), localhost:3002 (ws).
Metadata
The identity and technical contract details declared by the specification.
Channels & Operations 3
Across 3 channels, the API surfaces 3 operations. Each is listed below with its action, channel, parameters, and response codes.
Messages & Schemas 5
The contract defines 5 schemas that model the data carried by its messages. The most detailed are InAppMessage (9 properties), CountChangedPayload (2 properties), NotificationReceivedPayload (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable AsyncAPI contract behind this narrative.
Source
More from Novu 12
Other APIs Novu publishes across the network.