events

Subscribe to events as they are emitted, with optional filtering.

Resume from a known point with after (an opaque cursor from a prior delivery) and/or filter.afterCheckpoint. The subscription first backfills the matching events after that point via the scanning API, then continues with the live stream.

Each matching event is yielded individually as an edge, ordered by checkpoint, then by transaction position within the checkpoint, then by position within the transaction. Each edge carries a cursor for resumption.

Set progress to true to also receive progress payloads (a null node carrying only a cursor) during stretches that match nothing, so the resume cursor advances without waiting for a match. It defaults to false, where only matching events are delivered. Live progress is paced by the server and can be turned off there, so a live-only subscription may receive none.

This subscription is not yet available for use.

events(
  filter: EventFilter
  after: String
  progress: Boolean! = false
): EventSubscriptionEdge!

Arguments

events.filter ● EventFilter input

events.after ● String scalar

events.progress ● Boolean! non-null scalar

Type

EventSubscriptionEdge object

One payload of the events subscription: a matching event, or progress.