List sync events
Poll durable event records for API-only catch-up when webhooks are missed, disabled, or not configured.
GET
Requires API-key scope
Results are ordered oldest first by event time. Store
Each item includes:
sync.read and tenant permission webhook.view.
Use this endpoint as the API-only recovery path for webhook events. Zquence records each emitted event in a tenant-regional sync ledger before webhook endpoint matching or delivery decisions. That means the event can be polled even when no webhook endpoint exists, webhook delivery is disabled, or the receiver missed the original delivery.
Delivery logs are endpoint delivery diagnostics. Sync events are endpoint-independent event records for catch-up and reconciliation.
nextCursor after each successful page and pass it back as cursor on the next poll.
Query parameters
string
Opaque cursor returned as
nextCursor from a previous response.string
ISO 8601 timestamp. Used only when
cursor is not provided. Returns events whose event time is on or after this value.string
Exact webhook event type, such as
account.created, kyc.submitted, or contract.issued.string
Filter by inferred resource family. Current values include
account, account_document, account_source, account_case, kyc, tenant_user_invite, sanctions, and contract.string
Filter by inferred resource identifier for the selected resource family.
string
Filter to a specific environment. By default, API keys read their resolved environment. Pass
all to read across all tenant environments.integer
default:"100"
Number of events to return. Minimum
1, maximum 250.Returns
array
Ordered sync event records.
string | null
Cursor for the next page, or
null when there are no more events.boolean
true when another page is available.number
Page size used for this response.
string
Stable event ID. This matches
payload.id and should be used for deduplication.string
Webhook event type, such as
account.created.object
Original webhook event envelope with
id, type, tenantId, optional environment fields, data, and createdAt.string | null
Inferred resource family when available.
string | null
Inferred resource identifier when available.
string
ISO 8601 event timestamp used for ordering.