ReferenceWebhooks and events

Webhook endpoints

16 operations. Send Authorization: Bearer $PASSBOOK_KEY. Markdown

GET/api/v1/webhook-endpoints

Lists the endpoints of this mode.

webhooks:manageSDK pb.webhookEndpoints.list

Query

cursorstring · max 512

Returns

200 WebhookEndpointPage

Errors

CodeStatusFix
CAPTURE_DEVELOPER_ONLYMake your sandbox in the developer portal and call this in Test mode.
CAPTURE_NOT_STOREDSend the request again.
CAPTURE_TOO_LARGESend a smaller body.
CAPTURE_URL_FIXEDLeave the url out, or create a URL endpoint instead.
DELIVERY_PENDINGWait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying.
EVENT_NOT_FOUNDCheck the id with GET /api/v1/scan/events.
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_A_CAPTURE_ENDPOINTUse a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
REPLAY_NOT_QUEUEDSend the replay request again.
REPLAY_TOO_LARGENarrow the time range or replay in several smaller requests.
RETENTION_RECEIPT_BUSYWait a few seconds and send the request again.
SAMPLE_EVENT_LIVESend it to a Test endpoint, or send webhook.test.
SECRET_UNAVAILABLERotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
UNKNOWN_TEMPLATEUse template ids from GET /api/v1/templates.
UNSAFE_URLUse a public https URL.
VALIDATIONFix each field in issues and resend.
WEBHOOK_CAPTURE_NOT_FOUNDList the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures.
WEBHOOK_ENDPOINT_LIMITDelete one first.
WEBHOOK_ENDPOINT_NOT_FOUNDCheck the id with GET /api/v1/webhook-endpoints.
POST/api/v1/webhook-endpoints

Creates an endpoint for events of this mode. The signing secret is shown once. Send ?validate=1 to check the body without creating anything.

webhooks:manageSDK pb.webhookEndpoints.create

Query

validate"1"

Body

urlstring · max 2048Required
eventTypes"pass.issued" | "pass.updated" | "pass.voided" | "pass.unvoided" | "pass.removed" | "pass.restored" | "pass.installed" | "pass.uninstalled" | "pass.scanned" | "pass.scan_refused" | "pass.scan_undone" | "pass.channels_changed" | "pass.printed" | "pass.print_voided" | "push.failed" | "email.failed"[]Required
orgIdstring · max 64
descriptionstring · max 120
templateIdsarray | null

Returns

201 WebhookEndpointCreated

Errors

CodeStatusFix
CAPTURE_DEVELOPER_ONLYMake your sandbox in the developer portal and call this in Test mode.
CAPTURE_NOT_STOREDSend the request again.
CAPTURE_TOO_LARGESend a smaller body.
CAPTURE_URL_FIXEDLeave the url out, or create a URL endpoint instead.
DELIVERY_PENDINGWait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying.
EVENT_NOT_FOUNDCheck the id with GET /api/v1/scan/events.
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_A_CAPTURE_ENDPOINTUse a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
REPLAY_NOT_QUEUEDSend the replay request again.
REPLAY_TOO_LARGENarrow the time range or replay in several smaller requests.
RETENTION_RECEIPT_BUSYWait a few seconds and send the request again.
SAMPLE_EVENT_LIVESend it to a Test endpoint, or send webhook.test.
SECRET_UNAVAILABLERotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
UNKNOWN_TEMPLATEUse template ids from GET /api/v1/templates.
UNSAFE_URLUse a public https URL.
VALIDATIONFix each field in issues and resend.
WEBHOOK_CAPTURE_NOT_FOUNDList the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures.
WEBHOOK_ENDPOINT_LIMITDelete one first.
WEBHOOK_ENDPOINT_NOT_FOUNDCheck the id with GET /api/v1/webhook-endpoints.
GET/api/v1/webhook-endpoints/{id}

One endpoint. The signing secret is never returned.

webhooks:manageSDK pb.webhookEndpoints.retrieve

Path

idstring · max 64Required

Returns

200 WebhookEndpoint

Errors

CodeStatusFix
CAPTURE_DEVELOPER_ONLYMake your sandbox in the developer portal and call this in Test mode.
CAPTURE_NOT_STOREDSend the request again.
CAPTURE_TOO_LARGESend a smaller body.
CAPTURE_URL_FIXEDLeave the url out, or create a URL endpoint instead.
DELIVERY_PENDINGWait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying.
EVENT_NOT_FOUNDCheck the id with GET /api/v1/scan/events.
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_A_CAPTURE_ENDPOINTUse a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's.
NOT_FOUNDCheck the id, and that the key's mode (test or live) matches the object.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
REPLAY_NOT_QUEUEDSend the replay request again.
REPLAY_TOO_LARGENarrow the time range or replay in several smaller requests.
RETENTION_RECEIPT_BUSYWait a few seconds and send the request again.
SAMPLE_EVENT_LIVESend it to a Test endpoint, or send webhook.test.
SECRET_UNAVAILABLERotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
UNKNOWN_TEMPLATEUse template ids from GET /api/v1/templates.
UNSAFE_URLUse a public https URL.
VALIDATIONFix each field in issues and resend.
WEBHOOK_CAPTURE_NOT_FOUNDList the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures.
WEBHOOK_ENDPOINT_LIMITDelete one first.
WEBHOOK_ENDPOINT_NOT_FOUNDCheck the id with GET /api/v1/webhook-endpoints.
PATCH/api/v1/webhook-endpoints/{id}

Changes an endpoint, or pauses or resumes it with status. A disabled endpoint resumes with active.

webhooks:manageSDK pb.webhookEndpoints.update

Path

idstring · max 64Required

Body

urlstring · max 2048
description"" | string · max 120
eventTypes"pass.issued" | "pass.updated" | "pass.voided" | "pass.unvoided" | "pass.removed" | "pass.restored" | "pass.installed" | "pass.uninstalled" | "pass.scanned" | "pass.scan_refused" | "pass.scan_undone" | "pass.channels_changed" | "pass.printed" | "pass.print_voided" | "push.failed" | "email.failed"[]
templateIdsarray | null
status"active" | "paused"
apiVersion"2026-12-01"

Returns

200 WebhookEndpoint

Errors

CodeStatusFix
CAPTURE_DEVELOPER_ONLYMake your sandbox in the developer portal and call this in Test mode.
CAPTURE_NOT_STOREDSend the request again.
CAPTURE_TOO_LARGESend a smaller body.
CAPTURE_URL_FIXEDLeave the url out, or create a URL endpoint instead.
DELIVERY_PENDINGWait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying.
EVENT_NOT_FOUNDCheck the id with GET /api/v1/scan/events.
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_A_CAPTURE_ENDPOINTUse a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's.
NOT_FOUNDCheck the id, and that the key's mode (test or live) matches the object.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
REPLAY_NOT_QUEUEDSend the replay request again.
REPLAY_TOO_LARGENarrow the time range or replay in several smaller requests.
RETENTION_RECEIPT_BUSYWait a few seconds and send the request again.
SAMPLE_EVENT_LIVESend it to a Test endpoint, or send webhook.test.
SECRET_UNAVAILABLERotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
UNKNOWN_TEMPLATEUse template ids from GET /api/v1/templates.
UNSAFE_URLUse a public https URL.
VALIDATIONFix each field in issues and resend.
WEBHOOK_CAPTURE_NOT_FOUNDList the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures.
WEBHOOK_ENDPOINT_LIMITDelete one first.
WEBHOOK_ENDPOINT_NOT_FOUNDCheck the id with GET /api/v1/webhook-endpoints.
DEL/api/v1/webhook-endpoints/{id}

Deletes an endpoint and its delivery history.

webhooks:manageSDK pb.webhookEndpoints.delete

Path

idstring · max 64Required

Returns

200

Errors

CodeStatusFix
CAPTURE_DEVELOPER_ONLYMake your sandbox in the developer portal and call this in Test mode.
CAPTURE_NOT_STOREDSend the request again.
CAPTURE_TOO_LARGESend a smaller body.
CAPTURE_URL_FIXEDLeave the url out, or create a URL endpoint instead.
DELIVERY_PENDINGWait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying.
EVENT_NOT_FOUNDCheck the id with GET /api/v1/scan/events.
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_A_CAPTURE_ENDPOINTUse a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's.
NOT_FOUNDCheck the id, and that the key's mode (test or live) matches the object.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
REPLAY_NOT_QUEUEDSend the replay request again.
REPLAY_TOO_LARGENarrow the time range or replay in several smaller requests.
RETENTION_RECEIPT_BUSYWait a few seconds and send the request again.
SAMPLE_EVENT_LIVESend it to a Test endpoint, or send webhook.test.
SECRET_UNAVAILABLERotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
UNKNOWN_TEMPLATEUse template ids from GET /api/v1/templates.
UNSAFE_URLUse a public https URL.
VALIDATIONFix each field in issues and resend.
WEBHOOK_CAPTURE_NOT_FOUNDList the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures.
WEBHOOK_ENDPOINT_LIMITDelete one first.
WEBHOOK_ENDPOINT_NOT_FOUNDCheck the id with GET /api/v1/webhook-endpoints.
POST/api/v1/webhook-endpoints/{id}/secret

Rotates the signing secret and returns the new one once. The old secret stays valid for overlapHours (default 24).

webhooks:manageSDK pb.webhookEndpoints.rotateSecret

Path

idstring · max 64Required

Body

overlapHours0 | 24 | 72

Returns

200

Errors

CodeStatusFix
CAPTURE_DEVELOPER_ONLYMake your sandbox in the developer portal and call this in Test mode.
CAPTURE_NOT_STOREDSend the request again.
CAPTURE_TOO_LARGESend a smaller body.
CAPTURE_URL_FIXEDLeave the url out, or create a URL endpoint instead.
DELIVERY_PENDINGWait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying.
EVENT_NOT_FOUNDCheck the id with GET /api/v1/scan/events.
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_A_CAPTURE_ENDPOINTUse a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's.
NOT_FOUNDCheck the id, and that the key's mode (test or live) matches the object.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
REPLAY_NOT_QUEUEDSend the replay request again.
REPLAY_TOO_LARGENarrow the time range or replay in several smaller requests.
RETENTION_RECEIPT_BUSYWait a few seconds and send the request again.
SAMPLE_EVENT_LIVESend it to a Test endpoint, or send webhook.test.
SECRET_UNAVAILABLERotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
UNKNOWN_TEMPLATEUse template ids from GET /api/v1/templates.
UNSAFE_URLUse a public https URL.
VALIDATIONFix each field in issues and resend.
WEBHOOK_CAPTURE_NOT_FOUNDList the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures.
WEBHOOK_ENDPOINT_LIMITDelete one first.
WEBHOOK_ENDPOINT_NOT_FOUNDCheck the id with GET /api/v1/webhook-endpoints.
POST/api/v1/webhook-endpoints/{id}/test

Sends one signed event to the endpoint and reports the result. type is any event type and defaults to webhook.test; every other type carries sample data and goes to Test endpoints only. A capture endpoint stores the request and returns its captureId.

webhooks:manageSDK pb.webhookEndpoints.sendTest

Path

idstring · max 64Required

Body

type"pass.issued" | "pass.updated" | "pass.voided" | "pass.unvoided" | "pass.removed" | "pass.restored" | "pass.installed" | "pass.uninstalled" | "pass.scanned" | "pass.scan_refused" | "pass.scan_undone" | "pass.channels_changed" | "pass.printed" | "pass.print_voided" | "push.failed" | "email.failed" | "webhook.test"

Returns

200 WebhookTestResult

Errors

CodeStatusFix
CAPTURE_DEVELOPER_ONLYMake your sandbox in the developer portal and call this in Test mode.
CAPTURE_NOT_STOREDSend the request again.
CAPTURE_TOO_LARGESend a smaller body.
CAPTURE_URL_FIXEDLeave the url out, or create a URL endpoint instead.
DELIVERY_PENDINGWait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying.
EVENT_NOT_FOUNDCheck the id with GET /api/v1/scan/events.
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_A_CAPTURE_ENDPOINTUse a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's.
NOT_FOUNDCheck the id, and that the key's mode (test or live) matches the object.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
REPLAY_NOT_QUEUEDSend the replay request again.
REPLAY_TOO_LARGENarrow the time range or replay in several smaller requests.
RETENTION_RECEIPT_BUSYWait a few seconds and send the request again.
SAMPLE_EVENT_LIVESend it to a Test endpoint, or send webhook.test.
SECRET_UNAVAILABLERotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
UNKNOWN_TEMPLATEUse template ids from GET /api/v1/templates.
UNSAFE_URLUse a public https URL.
VALIDATIONFix each field in issues and resend.
WEBHOOK_CAPTURE_NOT_FOUNDList the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures.
WEBHOOK_ENDPOINT_LIMITDelete one first.
WEBHOOK_ENDPOINT_NOT_FOUNDCheck the id with GET /api/v1/webhook-endpoints.
POST/api/v1/webhook-endpoints/capture

Returns the capture endpoint of your sandbox, making it if there is none. A capture endpoint stores the signed requests PassBook would send, so you can read and verify them; it sends nothing and takes nothing from outside. Sandbox orgs in Test mode only. The signing secret is shown once, on creation; later calls return secret: null.

webhooks:manageSDK pb.webhookEndpoints.ensureCapture

Body

orgIdstring · max 64
eventTypes"pass.issued" | "pass.updated" | "pass.voided" | "pass.unvoided" | "pass.removed" | "pass.restored" | "pass.installed" | "pass.uninstalled" | "pass.scanned" | "pass.scan_refused" | "pass.scan_undone" | "pass.channels_changed" | "pass.printed" | "pass.print_voided" | "push.failed" | "email.failed"[]

Returns

201 CaptureEndpointCreated

Errors

CodeStatusFix
CAPTURE_DEVELOPER_ONLYMake your sandbox in the developer portal and call this in Test mode.
CAPTURE_NOT_STOREDSend the request again.
CAPTURE_TOO_LARGESend a smaller body.
CAPTURE_URL_FIXEDLeave the url out, or create a URL endpoint instead.
DELIVERY_PENDINGWait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying.
EVENT_NOT_FOUNDCheck the id with GET /api/v1/scan/events.
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_A_CAPTURE_ENDPOINTUse a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
REPLAY_NOT_QUEUEDSend the replay request again.
REPLAY_TOO_LARGENarrow the time range or replay in several smaller requests.
RETENTION_RECEIPT_BUSYWait a few seconds and send the request again.
SAMPLE_EVENT_LIVESend it to a Test endpoint, or send webhook.test.
SECRET_UNAVAILABLERotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
UNKNOWN_TEMPLATEUse template ids from GET /api/v1/templates.
UNSAFE_URLUse a public https URL.
VALIDATIONFix each field in issues and resend.
WEBHOOK_CAPTURE_NOT_FOUNDList the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures.
WEBHOOK_ENDPOINT_LIMITDelete one first.
WEBHOOK_ENDPOINT_NOT_FOUNDCheck the id with GET /api/v1/webhook-endpoints.

Captures

GET/api/v1/webhook-endpoints/{id}/captures

Requests a capture endpoint stored, newest first. Keeps 200 per endpoint for 7 days. Filter by type.

webhooks:manageSDK pb.webhookEndpoints.captures.list

Path

idstring · max 64Required

Query

cursorstring · ^\d{1,15}\.[A-Za-z0-9-]{1,64}$
limitinteger · ≥ 1 · ≤ 100
type"pass.issued" | "pass.updated" | "pass.voided" | "pass.unvoided" | "pass.removed" | "pass.restored" | "pass.installed" | "pass.uninstalled" | "pass.scanned" | "pass.scan_refused" | "pass.scan_undone" | "pass.channels_changed" | "pass.printed" | "pass.print_voided" | "push.failed" | "email.failed" | "webhook.test"

Returns

200 WebhookCapturePage

Errors

CodeStatusFix
CAPTURE_DEVELOPER_ONLYMake your sandbox in the developer portal and call this in Test mode.
CAPTURE_NOT_STOREDSend the request again.
CAPTURE_TOO_LARGESend a smaller body.
CAPTURE_URL_FIXEDLeave the url out, or create a URL endpoint instead.
DELIVERY_PENDINGWait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying.
EVENT_NOT_FOUNDCheck the id with GET /api/v1/scan/events.
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_A_CAPTURE_ENDPOINTUse a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's.
NOT_FOUNDCheck the id, and that the key's mode (test or live) matches the object.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
REPLAY_NOT_QUEUEDSend the replay request again.
REPLAY_TOO_LARGENarrow the time range or replay in several smaller requests.
RETENTION_RECEIPT_BUSYWait a few seconds and send the request again.
SAMPLE_EVENT_LIVESend it to a Test endpoint, or send webhook.test.
SECRET_UNAVAILABLERotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
UNKNOWN_TEMPLATEUse template ids from GET /api/v1/templates.
UNSAFE_URLUse a public https URL.
VALIDATIONFix each field in issues and resend.
WEBHOOK_CAPTURE_NOT_FOUNDList the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures.
WEBHOOK_ENDPOINT_LIMITDelete one first.
WEBHOOK_ENDPOINT_NOT_FOUNDCheck the id with GET /api/v1/webhook-endpoints.
GET/api/v1/webhook-endpoints/{id}/captures/{captureId}

One stored request: the exact headers and raw body. Verify the signature over these bytes.

webhooks:manageSDK pb.webhookEndpoints.captures.retrieve

Path

idstring · max 64Required
captureIdstring · max 64Required

Returns

200 WebhookCapture

Errors

CodeStatusFix
CAPTURE_DEVELOPER_ONLYMake your sandbox in the developer portal and call this in Test mode.
CAPTURE_NOT_STOREDSend the request again.
CAPTURE_TOO_LARGESend a smaller body.
CAPTURE_URL_FIXEDLeave the url out, or create a URL endpoint instead.
DELIVERY_PENDINGWait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying.
EVENT_NOT_FOUNDCheck the id with GET /api/v1/scan/events.
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_A_CAPTURE_ENDPOINTUse a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's.
NOT_FOUNDCheck the id, and that the key's mode (test or live) matches the object.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
REPLAY_NOT_QUEUEDSend the replay request again.
REPLAY_TOO_LARGENarrow the time range or replay in several smaller requests.
RETENTION_RECEIPT_BUSYWait a few seconds and send the request again.
SAMPLE_EVENT_LIVESend it to a Test endpoint, or send webhook.test.
SECRET_UNAVAILABLERotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
UNKNOWN_TEMPLATEUse template ids from GET /api/v1/templates.
UNSAFE_URLUse a public https URL.
VALIDATIONFix each field in issues and resend.
WEBHOOK_CAPTURE_NOT_FOUNDList the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures.
WEBHOOK_ENDPOINT_LIMITDelete one first.
WEBHOOK_ENDPOINT_NOT_FOUNDCheck the id with GET /api/v1/webhook-endpoints.
POST/api/v1/webhook-endpoints/{id}/captures/{captureId}/replay

Signs a stored request again with a fresh timestamp and stores it as a new capture with the same event id.

webhooks:manageSDK pb.webhookEndpoints.captures.replay

Path

idstring · max 64Required
captureIdstring · max 64Required

Returns

201 WebhookCapture

Errors

CodeStatusFix
CAPTURE_DEVELOPER_ONLYMake your sandbox in the developer portal and call this in Test mode.
CAPTURE_NOT_STOREDSend the request again.
CAPTURE_TOO_LARGESend a smaller body.
CAPTURE_URL_FIXEDLeave the url out, or create a URL endpoint instead.
DELIVERY_PENDINGWait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying.
EVENT_NOT_FOUNDCheck the id with GET /api/v1/scan/events.
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_A_CAPTURE_ENDPOINTUse a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's.
NOT_FOUNDCheck the id, and that the key's mode (test or live) matches the object.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
REPLAY_NOT_QUEUEDSend the replay request again.
REPLAY_TOO_LARGENarrow the time range or replay in several smaller requests.
RETENTION_RECEIPT_BUSYWait a few seconds and send the request again.
SAMPLE_EVENT_LIVESend it to a Test endpoint, or send webhook.test.
SECRET_UNAVAILABLERotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
UNKNOWN_TEMPLATEUse template ids from GET /api/v1/templates.
UNSAFE_URLUse a public https URL.
VALIDATIONFix each field in issues and resend.
WEBHOOK_CAPTURE_NOT_FOUNDList the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures.
WEBHOOK_ENDPOINT_LIMITDelete one first.
WEBHOOK_ENDPOINT_NOT_FOUNDCheck the id with GET /api/v1/webhook-endpoints.
POST/api/v1/webhook-endpoints/{id}/captures/secret

Returns the current signing secret of a capture endpoint, so you can verify its captures. It protects nothing outside your sandbox.

webhooks:manageSDK pb.webhookEndpoints.captures.revealSecret

Path

idstring · max 64Required

Returns

200 CaptureSecret

Errors

CodeStatusFix
CAPTURE_DEVELOPER_ONLYMake your sandbox in the developer portal and call this in Test mode.
CAPTURE_NOT_STOREDSend the request again.
CAPTURE_TOO_LARGESend a smaller body.
CAPTURE_URL_FIXEDLeave the url out, or create a URL endpoint instead.
DELIVERY_PENDINGWait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying.
EVENT_NOT_FOUNDCheck the id with GET /api/v1/scan/events.
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_A_CAPTURE_ENDPOINTUse a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's.
NOT_FOUNDCheck the id, and that the key's mode (test or live) matches the object.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
REPLAY_NOT_QUEUEDSend the replay request again.
REPLAY_TOO_LARGENarrow the time range or replay in several smaller requests.
RETENTION_RECEIPT_BUSYWait a few seconds and send the request again.
SAMPLE_EVENT_LIVESend it to a Test endpoint, or send webhook.test.
SECRET_UNAVAILABLERotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
UNKNOWN_TEMPLATEUse template ids from GET /api/v1/templates.
UNSAFE_URLUse a public https URL.
VALIDATIONFix each field in issues and resend.
WEBHOOK_CAPTURE_NOT_FOUNDList the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures.
WEBHOOK_ENDPOINT_LIMITDelete one first.
WEBHOOK_ENDPOINT_NOT_FOUNDCheck the id with GET /api/v1/webhook-endpoints.

Deliveries

GET/api/v1/webhook-endpoints/{id}/deliveries

Deliveries of an endpoint, newest first. Filter by state or type.

webhooks:manageSDK pb.webhookEndpoints.deliveries.list

Path

idstring · max 64Required

Query

cursorstring · max 512
limitinteger · ≥ 1 · ≤ 200
state"pending" | "delivered" | "failed" | "cancelled"
type"pass.issued" | "pass.updated" | "pass.voided" | "pass.unvoided" | "pass.removed" | "pass.restored" | "pass.installed" | "pass.uninstalled" | "pass.scanned" | "pass.scan_refused" | "pass.scan_undone" | "pass.channels_changed" | "pass.printed" | "pass.print_voided" | "push.failed" | "email.failed" | "webhook.test"

Returns

200 WebhookDeliveryPage

Errors

CodeStatusFix
CAPTURE_DEVELOPER_ONLYMake your sandbox in the developer portal and call this in Test mode.
CAPTURE_NOT_STOREDSend the request again.
CAPTURE_TOO_LARGESend a smaller body.
CAPTURE_URL_FIXEDLeave the url out, or create a URL endpoint instead.
DELIVERY_PENDINGWait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying.
EVENT_NOT_FOUNDCheck the id with GET /api/v1/scan/events.
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_A_CAPTURE_ENDPOINTUse a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's.
NOT_FOUNDCheck the id, and that the key's mode (test or live) matches the object.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
REPLAY_NOT_QUEUEDSend the replay request again.
REPLAY_TOO_LARGENarrow the time range or replay in several smaller requests.
RETENTION_RECEIPT_BUSYWait a few seconds and send the request again.
SAMPLE_EVENT_LIVESend it to a Test endpoint, or send webhook.test.
SECRET_UNAVAILABLERotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
UNKNOWN_TEMPLATEUse template ids from GET /api/v1/templates.
UNSAFE_URLUse a public https URL.
VALIDATIONFix each field in issues and resend.
WEBHOOK_CAPTURE_NOT_FOUNDList the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures.
WEBHOOK_ENDPOINT_LIMITDelete one first.
WEBHOOK_ENDPOINT_NOT_FOUNDCheck the id with GET /api/v1/webhook-endpoints.
GET/api/v1/webhook-endpoints/{id}/deliveries/{eventId}

One delivery with every attempt and the payload sent.

webhooks:manageSDK pb.webhookEndpoints.deliveries.retrieve

Path

idstring · max 64Required
eventIdstring · max 64Required

Returns

200 WebhookDeliveryDetail

Errors

CodeStatusFix
CAPTURE_DEVELOPER_ONLYMake your sandbox in the developer portal and call this in Test mode.
CAPTURE_NOT_STOREDSend the request again.
CAPTURE_TOO_LARGESend a smaller body.
CAPTURE_URL_FIXEDLeave the url out, or create a URL endpoint instead.
DELIVERY_PENDINGWait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying.
EVENT_NOT_FOUNDCheck the id with GET /api/v1/scan/events.
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_A_CAPTURE_ENDPOINTUse a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's.
NOT_FOUNDCheck the id, and that the key's mode (test or live) matches the object.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
REPLAY_NOT_QUEUEDSend the replay request again.
REPLAY_TOO_LARGENarrow the time range or replay in several smaller requests.
RETENTION_RECEIPT_BUSYWait a few seconds and send the request again.
SAMPLE_EVENT_LIVESend it to a Test endpoint, or send webhook.test.
SECRET_UNAVAILABLERotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
UNKNOWN_TEMPLATEUse template ids from GET /api/v1/templates.
UNSAFE_URLUse a public https URL.
VALIDATIONFix each field in issues and resend.
WEBHOOK_CAPTURE_NOT_FOUNDList the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures.
WEBHOOK_ENDPOINT_LIMITDelete one first.
WEBHOOK_ENDPOINT_NOT_FOUNDCheck the id with GET /api/v1/webhook-endpoints.
POST/api/v1/webhook-endpoints/{id}/deliveries/{eventId}/replay

Sends one delivery again with a fresh signature.

webhooks:manageSDK pb.webhookEndpoints.deliveries.replay

Path

idstring · max 64Required
eventIdstring · max 64Required

Returns

200

Errors

CodeStatusFix
CAPTURE_DEVELOPER_ONLYMake your sandbox in the developer portal and call this in Test mode.
CAPTURE_NOT_STOREDSend the request again.
CAPTURE_TOO_LARGESend a smaller body.
CAPTURE_URL_FIXEDLeave the url out, or create a URL endpoint instead.
DELIVERY_PENDINGWait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying.
EVENT_NOT_FOUNDCheck the id with GET /api/v1/scan/events.
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_A_CAPTURE_ENDPOINTUse a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's.
NOT_FOUNDCheck the id, and that the key's mode (test or live) matches the object.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
REPLAY_NOT_QUEUEDSend the replay request again.
REPLAY_TOO_LARGENarrow the time range or replay in several smaller requests.
RETENTION_RECEIPT_BUSYWait a few seconds and send the request again.
SAMPLE_EVENT_LIVESend it to a Test endpoint, or send webhook.test.
SECRET_UNAVAILABLERotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
UNKNOWN_TEMPLATEUse template ids from GET /api/v1/templates.
UNSAFE_URLUse a public https URL.
VALIDATIONFix each field in issues and resend.
WEBHOOK_CAPTURE_NOT_FOUNDList the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures.
WEBHOOK_ENDPOINT_LIMITDelete one first.
WEBHOOK_ENDPOINT_NOT_FOUNDCheck the id with GET /api/v1/webhook-endpoints.
POST/api/v1/webhook-endpoints/{id}/replay

Sends the deliveries in a time range again. dryRun counts without sending.

webhooks:manageSDK pb.webhookEndpoints.deliveries.bulkReplay

Path

idstring · max 64Required

Body

frominteger · ≥ 0Required
tointeger · ≥ 0Required
include"failed" | "failed_and_cancelled" | "all"
missingboolean
dryRunboolean

Returns

200

Errors

CodeStatusFix
CAPTURE_DEVELOPER_ONLYMake your sandbox in the developer portal and call this in Test mode.
CAPTURE_NOT_STOREDSend the request again.
CAPTURE_TOO_LARGESend a smaller body.
CAPTURE_URL_FIXEDLeave the url out, or create a URL endpoint instead.
DELIVERY_PENDINGWait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying.
EVENT_NOT_FOUNDCheck the id with GET /api/v1/scan/events.
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_A_CAPTURE_ENDPOINTUse a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's.
NOT_FOUNDCheck the id, and that the key's mode (test or live) matches the object.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
REPLAY_NOT_QUEUEDSend the replay request again.
REPLAY_TOO_LARGENarrow the time range or replay in several smaller requests.
RETENTION_RECEIPT_BUSYWait a few seconds and send the request again.
SAMPLE_EVENT_LIVESend it to a Test endpoint, or send webhook.test.
SECRET_UNAVAILABLERotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
UNKNOWN_TEMPLATEUse template ids from GET /api/v1/templates.
UNSAFE_URLUse a public https URL.
VALIDATIONFix each field in issues and resend.
WEBHOOK_CAPTURE_NOT_FOUNDList the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures.
WEBHOOK_ENDPOINT_LIMITDelete one first.
WEBHOOK_ENDPOINT_NOT_FOUNDCheck the id with GET /api/v1/webhook-endpoints.