Skip to main content

Subscribe to real-time entity change events via SSE

GET 
/api/v1/events/stream

Clients can subscribe to this endpoint to receive real-time notifications about entity changes (books, series, libraries) happening in the system.

Authentication​

Requires valid authentication with LibrariesRead permission.

Event Format​

Events are sent as JSON-encoded EntityChangeEvent objects with the following structure:

{
  "type": "book_created",
  "book_id": "uuid",
  "series_id": "uuid",
  "library_id": "uuid",
  "timestamp": "2024-01-06T12:00:00Z",
  "user_id": "uuid"
}

Keep-Alive​

A keep-alive message is sent every 15 seconds to prevent connection timeout.

Responses​

SSE stream of entity change events