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 anevent notification whose params is the event:
- Events of a session arrive in
seqorder, each once. - The response to
sessions.attacharrives before any replayed event. - The response to a write arrives before any event of that session the write caused.
after set to the last seq processed. A runner starting or stopping does not interrupt the subscription.
Acknowledge
Sendsessions.ack notifications as events are processed:
too_far_behind.
Deltas
An attach withdeltas: true also receives delta notifications. Types: API schema.
Detached
When the server ends a subscription it sendssession.detached with a reason: