Realtime event stream (WebSocket)

GET

/api/events

Upgrades to a WebSocket carrying job, pipeline and Hardcover sync events for the caller. Events are scoped to the authenticated principal; an admin additionally receives install-wide job events. The server closes the socket with application code 4401 when the session behind it is revoked (ban, sign-out, removal) and 4409 when the caller's identity or role changed and the client should re-dial to be re-scoped. Connections are capped per principal and process-wide.

Parameters

Query Parameters

bookId

Only deliver events concerning this book.

Type

string

Responses

Switching Protocols - the WebSocket is established.

GET

/api/events

Samples