ReferenceWebhooks and events

Events

2 operations. Send Authorization: Bearer $PASSBOOK_KEY. Markdown

GET/api/v1/events

The event feed, oldest first. Page with after. Takes the same events webhooks deliver.

passes:readSDK pb.events.list

Query

afterstring
typesstring · max 600
passIdstring · max 64
limitinteger · ≥ 1 · ≤ 200
apiVersion"2026-12-01"

Returns

200 EventPage

Errors

CodeStatusFix
FORBIDDENUse a key with the scope the operation lists, or ask an org admin.
INVALID_API_KEYCreate a new key in the console and update PASSBOOK_KEY.
INVALID_CURSORPass the nextCursor from the previous page unchanged, or drop it to start over.
MISSING_SCOPECreate a key with the scope the operation lists under security.
PASS_NOT_FOUNDCheck the id with GET /api/v1/passes and the key's mode.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
VALIDATIONFix each field in issues and resend.
GET/api/v1/events/{id}

One event by id.

passes:readSDK pb.events.retrieve

Path

idstring · max 64Required

Query

apiVersion"2026-12-01"

Returns

200 WebhookEvent

Errors

CodeStatusFix
FORBIDDENUse a key with the scope the operation lists, or ask an org admin.
INVALID_API_KEYCreate a new key in the console and update PASSBOOK_KEY.
INVALID_CURSORPass the nextCursor from the previous page unchanged, or drop it to start over.
MISSING_SCOPECreate a key with the scope the operation lists under security.
NOT_FOUNDCheck the id, and that the key's mode (test or live) matches the object.
PASS_NOT_FOUNDCheck the id with GET /api/v1/passes and the key's mode.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
VALIDATIONFix each field in issues and resend.