Skip to main content
actor is who caused the event (via is slack, opc, dashboard or api), or null. Event types and their data fields: API schema. A client must ignore types it does not know.

Read a range

events.list (GET /sessions/{id}/events) returns events in seq order. To follow a session over HTTP, loop on it with after and waitMs.
The result is events, earlierTurns, lastSeq (the journal’s last seq) and hasMore.

Follow live

Attach over WebSocket. Each event arrives as an event notification whose params is the event:
Order on one connection:
  • Events of a session arrive in seq order, each once.
  • The response to sessions.attach arrives before any replayed event.
  • The response to a write arrives before any event of that session the write caused.
When the whole connection closes, reconnect and attach with after set to the last seq processed. A runner starting or stopping does not interrupt the subscription.

Acknowledge

Send sessions.ack notifications as events are processed:
The backlog of a session is its events not yet sent or, once the client has sent an ack, not yet acknowledged. When it passes 10,000 events or 8 MiB, the server detaches that session with too_far_behind.

Deltas

An attach with deltas: true also receives delta notifications. Types: API schema.

Detached

When the server ends a subscription it sends session.detached with a reason: