Collectoh
EN

This page is in English only for now. The main pages follow your choice.

Sign up free
Browse the docs

API reference

Events

Server-sent events for live updates.

Paths are relative to /api/v1 on your server.

GET/events#

Server-sent events

A text/event-stream of the events in @collectoh/shared/events, scoped to what the caller may see. types filters by comma-separated event type; Last-Event-ID (or lastEventId) replays what was missed.

Authorisation
Bearer token or API key · Session cookie
ParameterInTypeDescription
typesquerystring
lastEventIdquerystring
  • 200Success. text/event-stream · string
  • 400VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope
  • 401UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope
  • 403FORBIDDEN: the account lacks library:view, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope