Skip to main content
GET
Read events (pull)

Authorizations

Authorization
string
header
required

An API key from Settings → API keys, sent as Authorization: Bearer yk_live_…. Scopes: transfers:read, transfers:write, collections:read, collections:write, contacts:read, contacts:write, webhooks:read, webhooks:write. A write scope implies read of the same resource.

Path Parameters

id
string
required

Webhook endpoint id.

Query Parameters

limit
integer

Page size, 1–500. Defaults to 100.

Required range: 1 <= x <= 500
cursor
string

The nextCursor from the previous page, unchanged. Opaque: never build one.

Response

Events, each the same JSON a push delivery sends, plus deliveryId.

events
object[]
required
nextCursor
string | null
required

Returned even on the last page, so a poller resumes from it.

hasMore
boolean
required