AuralisDocs
OperationsNotifications

Stream new notifications as they arrive

A Server-Sent Events stream of this user's new notifications.

/v1/notifications/streamViewer
Operation id
stream_notifications
Access
Any workspace role can call this.
GET/v1/notifications/stream

A Server-Sent Events stream of this user's new notifications.

This is SSE, not JSON. Hold the connection open and read events as they arrive. Two event names are emitted: notification for each new one, and count carrying the current unread total. The count is sent on every tick even when nothing new arrived, so a badge stays right when the user marks something read in another tab.

Only notifications created after you connect are streamed. On connect the stream starts from the newest existing row, so it never replays history. Call the list operation for what is already there.

New rows are picked up about once a second, and at most 20 per tick. Reconnect if the connection drops.

Tenancy: the request is scoped to one workspace, and the credential presented is what selects it. A caller with no membership in that workspace is refused with 404, which is indistinguishable from a workspace that does not exist.

Authorisation: any workspace role, including viewer. Reads are open to every member.

Access: Authorization: Bearer carrying either a realm access token or an API key. A key must hold the notifications:read scope, and the workspace role of the person who owns it must meet the floor above.

Authorization

AuthorizationBearer <token>

A realm-issued access token, presented as Authorization: Bearer <token>. It acts as the person who signed in, and every operation resolves their workspace role live from the membership record.

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/notifications/stream"
null