Lexicon Garden

network.bsky.jetstream.subscribeEvents

Stream every archived and live Jetstream event in seq order, framed per the xrpc.v1.json subprotocol. The kinds, dids, and collections filters are independent predicates ANDed together; each is match-all when omitted. See the parameter and error descriptions for cursor, filtering, and compression semantics.

Repository @bsky-lexicons.bsky.social did:plc:4v4y5r3lwsbtmsxhile2ljac namespace authority
Details · subscription
Kindsubscription
Authorityjetstream.bsky.network
Indexed
Compare Edit in builder → Fork →

Subscription

subscription · WebSocket

Parameters

query string

collections

array

Collection NSIDs or '<prefix>.*' patterns; constrains which commit events are delivered. Non-commit kinds are unaffected — combine with kinds=commit for a commits-only collection stream. Rejected pre-upgrade with HTTP 400 (InvalidRequest) when kinds is set and excludes commit, since the filter could never apply. Omitted or empty: all collections.

  • maxLength: 100
itemsstring

cursor

integer

Resume position, inclusive: the server replays events with seq >= cursor and the client dedups the overlap. Values >= 1e15 are interpreted as a unix-microseconds timestamp instead of a seq and translated to the first seq witnessed at or after that instant; a timestamp below the retention floor clamps up to the floor and an #info OutdatedCursor frame is sent. Omitted: start at the live tip.

dids

array

Repo DIDs to receive events for; applies to every event kind. Omitted or empty: all repos.

  • maxLength: 10000
itemsstring · did

kinds

array

Event kinds to receive; values are the message $type fragment names. Omitted or empty: all kinds. A value outside the enum is rejected pre-upgrade with HTTP 400 (InvalidRequest) rather than silently never matching.

  • maxLength: 4
itemsstring
  • enum: commit | identity | account | sync

maxMessageSizeBytes

integer

Skip events whose uncompressed frame (envelope included) exceeds this many bytes. 0 (default) means no limit.

  • minimum: 0
  • maximum: 4294967295
  • default: 0

zstdDictionary

integer

Jetstream extension: opt into dict-zstd frame compression with the given zstd dictionary ID (obtained via network.bsky.jetstream.getZstdDictionary). Frames then arrive as binary websocket messages, each one zstd frame whose decompressed bytes are exactly the xrpc.v1.json text frame. An unknown or retired ID is rejected pre-upgrade with HTTP 400 carrying the current ID.

  • minimum: 1

Messages

DAG-CBOR frames

#commit

object

A single record mutation (create, update, or delete).

#identity

object

An identity change (handle or DID document update), wrapping the upstream firehose event verbatim.

#account

object

An account status change (active/deactivated/deleted/...), wrapping the upstream firehose event verbatim.

#sync

object

An archived #sync event (broken commit chain; consumers should resync the repo), wrapping the upstream firehose event verbatim. Never emitted on the legacy v1 /subscribe wire.

#info

object

An advisory, non-fatal notice about the stream (mirrors com.atproto.sync.subscribeRepos#info). Carries no seq and does not advance the cursor. OutdatedCursor is sent as the first frame when a unix-microseconds timestamp cursor below the retention floor was clamped up to the floor; the message names the seq actually resumed from.

Errors

ConsumerTooSlow

The client is far behind the live tip AND reading below the server's floor rate for a sustained window; the server drops adversarially-slow readers. A merely-slow-but-progressing reader is never dropped.

CursorTooOld

Rejected pre-upgrade with HTTP 400, never as a stream error frame: the requested seq cursor is below the server's retention floor. The message carries the floor seq; archive-backfilling clients re-enter backfill from their last durable seq.

UnknownZstdDictionary

Rejected pre-upgrade with HTTP 400, never as a stream error frame: the zstdDictionary ID is unknown or retired. The message carries the current dictionary ID; re-fetch via network.bsky.jetstream.getZstdDictionary.

#account

object

An account status change (active/deactivated/deleted/...), wrapping the upstream firehose event verbatim.

Properties

account

requiredref

The upstream event; its seq and time are the upstream relay's, not Jetstream's.

Reference

did

requiredstring · did

seq

requiredinteger

time

requiredstring · datetime

The time Jetstream witnessed this event, microsecond precision. Timestamp imports apply only to record (commit) events, so this is always the witnessed time.

#commit

object

A single record mutation (create, update, or delete).

Properties

cid

string · cid

CID of the record. Absent for deletes.

collection

requiredstring · nsid

Collection NSID of the record.

did

requiredstring · did

operation

requiredstring
  • knownValues: create | update | delete

record

unknown

The record decoded to JSON. Absent for deletes.

rev

requiredstring · tid

The repo rev of the commit that produced this op.

rkey

requiredstring · record-key

Record key.

seq

requiredinteger

Jetstream's monotonic per-event sequence number; the stream cursor.

time

requiredstring · datetime

The event's display timestamp, microsecond precision: when Jetstream witnessed the event, unless an operator timestamp import overrode it. Timestamp cursors translate against the witnessed time, so after an import this value may not be a faithful resume position.

#identity

object

An identity change (handle or DID document update), wrapping the upstream firehose event verbatim.

Properties

did

requiredstring · did

identity

requiredref

The upstream event; its seq and time are the upstream relay's, not Jetstream's.

Reference

seq

requiredinteger

time

requiredstring · datetime

The time Jetstream witnessed this event, microsecond precision. Timestamp imports apply only to record (commit) events, so this is always the witnessed time.

#info

object

An advisory, non-fatal notice about the stream (mirrors com.atproto.sync.subscribeRepos#info). Carries no seq and does not advance the cursor. OutdatedCursor is sent as the first frame when a unix-microseconds timestamp cursor below the retention floor was clamped up to the floor; the message names the seq actually resumed from.

Properties

message

string

name

requiredstring
  • knownValues: OutdatedCursor

#sync

object

An archived #sync event (broken commit chain; consumers should resync the repo), wrapping the upstream firehose event verbatim. Never emitted on the legacy v1 /subscribe wire.

Properties

did

requiredstring · did

seq

requiredinteger

sync

requiredref

The upstream event; its seq and time are the upstream relay's, not Jetstream's.

Reference

time

requiredstring · datetime

The time Jetstream witnessed this event, microsecond precision. Timestamp imports apply only to record (commit) events, so this is always the witnessed time.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • com.atproto.sync.subscribeRepos

    subscription

    Repository event stream, aka Firehose endpoint. Outputs repo commits with diff data, and identity update events, for all repositories on the current server. See the atproto specifications for details around stream sequencing, repo versioning, CAR diff format, and more. Public and does not require auth; implemented by PDS and Relay.

  • zone.stratos.sync.subscribeRecords

    subscription

    Subscribe to stratos events. When 'did' is provided, subscribes to record updates for that account. When omitted, subscribes to service-level events (enrollments). Callers must authenticate with a signed service JWT via the Authorization: Bearer header.