Webhook endpoints
16 operations. Send Authorization: Bearer $PASSBOOK_KEY. Markdown
/api/v1/webhook-endpointsLists the endpoints of this mode.
Query
Returns
200 WebhookEndpointPage
Errors
| Code | Status | Fix |
|---|---|---|
| CAPTURE_DEVELOPER_ONLY | Make your sandbox in the developer portal and call this in Test mode. | |
| CAPTURE_NOT_STORED | Send the request again. | |
| CAPTURE_TOO_LARGE | Send a smaller body. | |
| CAPTURE_URL_FIXED | Leave the url out, or create a URL endpoint instead. | |
| DELIVERY_PENDING | Wait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying. | |
| EVENT_NOT_FOUND | Check the id with GET /api/v1/scan/events. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_CAPTURE_ENDPOINT | Use a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| REPLAY_NOT_QUEUED | Send the replay request again. | |
| REPLAY_TOO_LARGE | Narrow the time range or replay in several smaller requests. | |
| RETENTION_RECEIPT_BUSY | Wait a few seconds and send the request again. | |
| SAMPLE_EVENT_LIVE | Send it to a Test endpoint, or send webhook.test. | |
| SECRET_UNAVAILABLE | Rotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UNKNOWN_TEMPLATE | Use template ids from GET /api/v1/templates. | |
| UNSAFE_URL | Use a public https URL. | |
| VALIDATION | Fix each field in issues and resend. | |
| WEBHOOK_CAPTURE_NOT_FOUND | List the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures. | |
| WEBHOOK_ENDPOINT_LIMIT | Delete one first. | |
| WEBHOOK_ENDPOINT_NOT_FOUND | Check the id with GET /api/v1/webhook-endpoints. |
/api/v1/webhook-endpointsCreates an endpoint for events of this mode. The signing secret is shown once. Send ?validate=1 to check the body without creating anything.
Query
Body
Returns
201 WebhookEndpointCreated
Errors
| Code | Status | Fix |
|---|---|---|
| CAPTURE_DEVELOPER_ONLY | Make your sandbox in the developer portal and call this in Test mode. | |
| CAPTURE_NOT_STORED | Send the request again. | |
| CAPTURE_TOO_LARGE | Send a smaller body. | |
| CAPTURE_URL_FIXED | Leave the url out, or create a URL endpoint instead. | |
| DELIVERY_PENDING | Wait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying. | |
| EVENT_NOT_FOUND | Check the id with GET /api/v1/scan/events. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_CAPTURE_ENDPOINT | Use a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| REPLAY_NOT_QUEUED | Send the replay request again. | |
| REPLAY_TOO_LARGE | Narrow the time range or replay in several smaller requests. | |
| RETENTION_RECEIPT_BUSY | Wait a few seconds and send the request again. | |
| SAMPLE_EVENT_LIVE | Send it to a Test endpoint, or send webhook.test. | |
| SECRET_UNAVAILABLE | Rotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UNKNOWN_TEMPLATE | Use template ids from GET /api/v1/templates. | |
| UNSAFE_URL | Use a public https URL. | |
| VALIDATION | Fix each field in issues and resend. | |
| WEBHOOK_CAPTURE_NOT_FOUND | List the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures. | |
| WEBHOOK_ENDPOINT_LIMIT | Delete one first. | |
| WEBHOOK_ENDPOINT_NOT_FOUND | Check the id with GET /api/v1/webhook-endpoints. |
/api/v1/webhook-endpoints/{id}One endpoint. The signing secret is never returned.
Path
Returns
200 WebhookEndpoint
Errors
| Code | Status | Fix |
|---|---|---|
| CAPTURE_DEVELOPER_ONLY | Make your sandbox in the developer portal and call this in Test mode. | |
| CAPTURE_NOT_STORED | Send the request again. | |
| CAPTURE_TOO_LARGE | Send a smaller body. | |
| CAPTURE_URL_FIXED | Leave the url out, or create a URL endpoint instead. | |
| DELIVERY_PENDING | Wait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying. | |
| EVENT_NOT_FOUND | Check the id with GET /api/v1/scan/events. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_CAPTURE_ENDPOINT | Use a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| REPLAY_NOT_QUEUED | Send the replay request again. | |
| REPLAY_TOO_LARGE | Narrow the time range or replay in several smaller requests. | |
| RETENTION_RECEIPT_BUSY | Wait a few seconds and send the request again. | |
| SAMPLE_EVENT_LIVE | Send it to a Test endpoint, or send webhook.test. | |
| SECRET_UNAVAILABLE | Rotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UNKNOWN_TEMPLATE | Use template ids from GET /api/v1/templates. | |
| UNSAFE_URL | Use a public https URL. | |
| VALIDATION | Fix each field in issues and resend. | |
| WEBHOOK_CAPTURE_NOT_FOUND | List the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures. | |
| WEBHOOK_ENDPOINT_LIMIT | Delete one first. | |
| WEBHOOK_ENDPOINT_NOT_FOUND | Check the id with GET /api/v1/webhook-endpoints. |
/api/v1/webhook-endpoints/{id}Changes an endpoint, or pauses or resumes it with status. A disabled endpoint resumes with active.
Path
Body
Returns
200 WebhookEndpoint
Errors
| Code | Status | Fix |
|---|---|---|
| CAPTURE_DEVELOPER_ONLY | Make your sandbox in the developer portal and call this in Test mode. | |
| CAPTURE_NOT_STORED | Send the request again. | |
| CAPTURE_TOO_LARGE | Send a smaller body. | |
| CAPTURE_URL_FIXED | Leave the url out, or create a URL endpoint instead. | |
| DELIVERY_PENDING | Wait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying. | |
| EVENT_NOT_FOUND | Check the id with GET /api/v1/scan/events. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_CAPTURE_ENDPOINT | Use a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| REPLAY_NOT_QUEUED | Send the replay request again. | |
| REPLAY_TOO_LARGE | Narrow the time range or replay in several smaller requests. | |
| RETENTION_RECEIPT_BUSY | Wait a few seconds and send the request again. | |
| SAMPLE_EVENT_LIVE | Send it to a Test endpoint, or send webhook.test. | |
| SECRET_UNAVAILABLE | Rotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UNKNOWN_TEMPLATE | Use template ids from GET /api/v1/templates. | |
| UNSAFE_URL | Use a public https URL. | |
| VALIDATION | Fix each field in issues and resend. | |
| WEBHOOK_CAPTURE_NOT_FOUND | List the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures. | |
| WEBHOOK_ENDPOINT_LIMIT | Delete one first. | |
| WEBHOOK_ENDPOINT_NOT_FOUND | Check the id with GET /api/v1/webhook-endpoints. |
/api/v1/webhook-endpoints/{id}Deletes an endpoint and its delivery history.
Path
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| CAPTURE_DEVELOPER_ONLY | Make your sandbox in the developer portal and call this in Test mode. | |
| CAPTURE_NOT_STORED | Send the request again. | |
| CAPTURE_TOO_LARGE | Send a smaller body. | |
| CAPTURE_URL_FIXED | Leave the url out, or create a URL endpoint instead. | |
| DELIVERY_PENDING | Wait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying. | |
| EVENT_NOT_FOUND | Check the id with GET /api/v1/scan/events. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_CAPTURE_ENDPOINT | Use a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| REPLAY_NOT_QUEUED | Send the replay request again. | |
| REPLAY_TOO_LARGE | Narrow the time range or replay in several smaller requests. | |
| RETENTION_RECEIPT_BUSY | Wait a few seconds and send the request again. | |
| SAMPLE_EVENT_LIVE | Send it to a Test endpoint, or send webhook.test. | |
| SECRET_UNAVAILABLE | Rotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UNKNOWN_TEMPLATE | Use template ids from GET /api/v1/templates. | |
| UNSAFE_URL | Use a public https URL. | |
| VALIDATION | Fix each field in issues and resend. | |
| WEBHOOK_CAPTURE_NOT_FOUND | List the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures. | |
| WEBHOOK_ENDPOINT_LIMIT | Delete one first. | |
| WEBHOOK_ENDPOINT_NOT_FOUND | Check the id with GET /api/v1/webhook-endpoints. |
/api/v1/webhook-endpoints/{id}/secretRotates the signing secret and returns the new one once. The old secret stays valid for overlapHours (default 24).
Path
Body
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| CAPTURE_DEVELOPER_ONLY | Make your sandbox in the developer portal and call this in Test mode. | |
| CAPTURE_NOT_STORED | Send the request again. | |
| CAPTURE_TOO_LARGE | Send a smaller body. | |
| CAPTURE_URL_FIXED | Leave the url out, or create a URL endpoint instead. | |
| DELIVERY_PENDING | Wait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying. | |
| EVENT_NOT_FOUND | Check the id with GET /api/v1/scan/events. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_CAPTURE_ENDPOINT | Use a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| REPLAY_NOT_QUEUED | Send the replay request again. | |
| REPLAY_TOO_LARGE | Narrow the time range or replay in several smaller requests. | |
| RETENTION_RECEIPT_BUSY | Wait a few seconds and send the request again. | |
| SAMPLE_EVENT_LIVE | Send it to a Test endpoint, or send webhook.test. | |
| SECRET_UNAVAILABLE | Rotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UNKNOWN_TEMPLATE | Use template ids from GET /api/v1/templates. | |
| UNSAFE_URL | Use a public https URL. | |
| VALIDATION | Fix each field in issues and resend. | |
| WEBHOOK_CAPTURE_NOT_FOUND | List the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures. | |
| WEBHOOK_ENDPOINT_LIMIT | Delete one first. | |
| WEBHOOK_ENDPOINT_NOT_FOUND | Check the id with GET /api/v1/webhook-endpoints. |
/api/v1/webhook-endpoints/{id}/testSends 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.
Path
Body
Returns
200 WebhookTestResult
Errors
| Code | Status | Fix |
|---|---|---|
| CAPTURE_DEVELOPER_ONLY | Make your sandbox in the developer portal and call this in Test mode. | |
| CAPTURE_NOT_STORED | Send the request again. | |
| CAPTURE_TOO_LARGE | Send a smaller body. | |
| CAPTURE_URL_FIXED | Leave the url out, or create a URL endpoint instead. | |
| DELIVERY_PENDING | Wait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying. | |
| EVENT_NOT_FOUND | Check the id with GET /api/v1/scan/events. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_CAPTURE_ENDPOINT | Use a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| REPLAY_NOT_QUEUED | Send the replay request again. | |
| REPLAY_TOO_LARGE | Narrow the time range or replay in several smaller requests. | |
| RETENTION_RECEIPT_BUSY | Wait a few seconds and send the request again. | |
| SAMPLE_EVENT_LIVE | Send it to a Test endpoint, or send webhook.test. | |
| SECRET_UNAVAILABLE | Rotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UNKNOWN_TEMPLATE | Use template ids from GET /api/v1/templates. | |
| UNSAFE_URL | Use a public https URL. | |
| VALIDATION | Fix each field in issues and resend. | |
| WEBHOOK_CAPTURE_NOT_FOUND | List the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures. | |
| WEBHOOK_ENDPOINT_LIMIT | Delete one first. | |
| WEBHOOK_ENDPOINT_NOT_FOUND | Check the id with GET /api/v1/webhook-endpoints. |
/api/v1/webhook-endpoints/captureReturns 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.
Body
Returns
201 CaptureEndpointCreated
Errors
| Code | Status | Fix |
|---|---|---|
| CAPTURE_DEVELOPER_ONLY | Make your sandbox in the developer portal and call this in Test mode. | |
| CAPTURE_NOT_STORED | Send the request again. | |
| CAPTURE_TOO_LARGE | Send a smaller body. | |
| CAPTURE_URL_FIXED | Leave the url out, or create a URL endpoint instead. | |
| DELIVERY_PENDING | Wait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying. | |
| EVENT_NOT_FOUND | Check the id with GET /api/v1/scan/events. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_CAPTURE_ENDPOINT | Use a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| REPLAY_NOT_QUEUED | Send the replay request again. | |
| REPLAY_TOO_LARGE | Narrow the time range or replay in several smaller requests. | |
| RETENTION_RECEIPT_BUSY | Wait a few seconds and send the request again. | |
| SAMPLE_EVENT_LIVE | Send it to a Test endpoint, or send webhook.test. | |
| SECRET_UNAVAILABLE | Rotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UNKNOWN_TEMPLATE | Use template ids from GET /api/v1/templates. | |
| UNSAFE_URL | Use a public https URL. | |
| VALIDATION | Fix each field in issues and resend. | |
| WEBHOOK_CAPTURE_NOT_FOUND | List the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures. | |
| WEBHOOK_ENDPOINT_LIMIT | Delete one first. | |
| WEBHOOK_ENDPOINT_NOT_FOUND | Check the id with GET /api/v1/webhook-endpoints. |
Captures
/api/v1/webhook-endpoints/{id}/capturesRequests a capture endpoint stored, newest first. Keeps 200 per endpoint for 7 days. Filter by type.
Path
Query
Returns
200 WebhookCapturePage
Errors
| Code | Status | Fix |
|---|---|---|
| CAPTURE_DEVELOPER_ONLY | Make your sandbox in the developer portal and call this in Test mode. | |
| CAPTURE_NOT_STORED | Send the request again. | |
| CAPTURE_TOO_LARGE | Send a smaller body. | |
| CAPTURE_URL_FIXED | Leave the url out, or create a URL endpoint instead. | |
| DELIVERY_PENDING | Wait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying. | |
| EVENT_NOT_FOUND | Check the id with GET /api/v1/scan/events. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_CAPTURE_ENDPOINT | Use a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| REPLAY_NOT_QUEUED | Send the replay request again. | |
| REPLAY_TOO_LARGE | Narrow the time range or replay in several smaller requests. | |
| RETENTION_RECEIPT_BUSY | Wait a few seconds and send the request again. | |
| SAMPLE_EVENT_LIVE | Send it to a Test endpoint, or send webhook.test. | |
| SECRET_UNAVAILABLE | Rotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UNKNOWN_TEMPLATE | Use template ids from GET /api/v1/templates. | |
| UNSAFE_URL | Use a public https URL. | |
| VALIDATION | Fix each field in issues and resend. | |
| WEBHOOK_CAPTURE_NOT_FOUND | List the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures. | |
| WEBHOOK_ENDPOINT_LIMIT | Delete one first. | |
| WEBHOOK_ENDPOINT_NOT_FOUND | Check the id with GET /api/v1/webhook-endpoints. |
/api/v1/webhook-endpoints/{id}/captures/{captureId}One stored request: the exact headers and raw body. Verify the signature over these bytes.
Path
Returns
200 WebhookCapture
Errors
| Code | Status | Fix |
|---|---|---|
| CAPTURE_DEVELOPER_ONLY | Make your sandbox in the developer portal and call this in Test mode. | |
| CAPTURE_NOT_STORED | Send the request again. | |
| CAPTURE_TOO_LARGE | Send a smaller body. | |
| CAPTURE_URL_FIXED | Leave the url out, or create a URL endpoint instead. | |
| DELIVERY_PENDING | Wait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying. | |
| EVENT_NOT_FOUND | Check the id with GET /api/v1/scan/events. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_CAPTURE_ENDPOINT | Use a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| REPLAY_NOT_QUEUED | Send the replay request again. | |
| REPLAY_TOO_LARGE | Narrow the time range or replay in several smaller requests. | |
| RETENTION_RECEIPT_BUSY | Wait a few seconds and send the request again. | |
| SAMPLE_EVENT_LIVE | Send it to a Test endpoint, or send webhook.test. | |
| SECRET_UNAVAILABLE | Rotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UNKNOWN_TEMPLATE | Use template ids from GET /api/v1/templates. | |
| UNSAFE_URL | Use a public https URL. | |
| VALIDATION | Fix each field in issues and resend. | |
| WEBHOOK_CAPTURE_NOT_FOUND | List the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures. | |
| WEBHOOK_ENDPOINT_LIMIT | Delete one first. | |
| WEBHOOK_ENDPOINT_NOT_FOUND | Check the id with GET /api/v1/webhook-endpoints. |
/api/v1/webhook-endpoints/{id}/captures/{captureId}/replaySigns a stored request again with a fresh timestamp and stores it as a new capture with the same event id.
Path
Returns
201 WebhookCapture
Errors
| Code | Status | Fix |
|---|---|---|
| CAPTURE_DEVELOPER_ONLY | Make your sandbox in the developer portal and call this in Test mode. | |
| CAPTURE_NOT_STORED | Send the request again. | |
| CAPTURE_TOO_LARGE | Send a smaller body. | |
| CAPTURE_URL_FIXED | Leave the url out, or create a URL endpoint instead. | |
| DELIVERY_PENDING | Wait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying. | |
| EVENT_NOT_FOUND | Check the id with GET /api/v1/scan/events. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_CAPTURE_ENDPOINT | Use a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| REPLAY_NOT_QUEUED | Send the replay request again. | |
| REPLAY_TOO_LARGE | Narrow the time range or replay in several smaller requests. | |
| RETENTION_RECEIPT_BUSY | Wait a few seconds and send the request again. | |
| SAMPLE_EVENT_LIVE | Send it to a Test endpoint, or send webhook.test. | |
| SECRET_UNAVAILABLE | Rotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UNKNOWN_TEMPLATE | Use template ids from GET /api/v1/templates. | |
| UNSAFE_URL | Use a public https URL. | |
| VALIDATION | Fix each field in issues and resend. | |
| WEBHOOK_CAPTURE_NOT_FOUND | List the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures. | |
| WEBHOOK_ENDPOINT_LIMIT | Delete one first. | |
| WEBHOOK_ENDPOINT_NOT_FOUND | Check the id with GET /api/v1/webhook-endpoints. |
/api/v1/webhook-endpoints/{id}/captures/secretReturns the current signing secret of a capture endpoint, so you can verify its captures. It protects nothing outside your sandbox.
Path
Returns
200 CaptureSecret
Errors
| Code | Status | Fix |
|---|---|---|
| CAPTURE_DEVELOPER_ONLY | Make your sandbox in the developer portal and call this in Test mode. | |
| CAPTURE_NOT_STORED | Send the request again. | |
| CAPTURE_TOO_LARGE | Send a smaller body. | |
| CAPTURE_URL_FIXED | Leave the url out, or create a URL endpoint instead. | |
| DELIVERY_PENDING | Wait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying. | |
| EVENT_NOT_FOUND | Check the id with GET /api/v1/scan/events. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_CAPTURE_ENDPOINT | Use a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| REPLAY_NOT_QUEUED | Send the replay request again. | |
| REPLAY_TOO_LARGE | Narrow the time range or replay in several smaller requests. | |
| RETENTION_RECEIPT_BUSY | Wait a few seconds and send the request again. | |
| SAMPLE_EVENT_LIVE | Send it to a Test endpoint, or send webhook.test. | |
| SECRET_UNAVAILABLE | Rotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UNKNOWN_TEMPLATE | Use template ids from GET /api/v1/templates. | |
| UNSAFE_URL | Use a public https URL. | |
| VALIDATION | Fix each field in issues and resend. | |
| WEBHOOK_CAPTURE_NOT_FOUND | List the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures. | |
| WEBHOOK_ENDPOINT_LIMIT | Delete one first. | |
| WEBHOOK_ENDPOINT_NOT_FOUND | Check the id with GET /api/v1/webhook-endpoints. |
Deliveries
/api/v1/webhook-endpoints/{id}/deliveriesDeliveries of an endpoint, newest first. Filter by state or type.
Path
Query
Returns
200 WebhookDeliveryPage
Errors
| Code | Status | Fix |
|---|---|---|
| CAPTURE_DEVELOPER_ONLY | Make your sandbox in the developer portal and call this in Test mode. | |
| CAPTURE_NOT_STORED | Send the request again. | |
| CAPTURE_TOO_LARGE | Send a smaller body. | |
| CAPTURE_URL_FIXED | Leave the url out, or create a URL endpoint instead. | |
| DELIVERY_PENDING | Wait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying. | |
| EVENT_NOT_FOUND | Check the id with GET /api/v1/scan/events. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_CAPTURE_ENDPOINT | Use a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| REPLAY_NOT_QUEUED | Send the replay request again. | |
| REPLAY_TOO_LARGE | Narrow the time range or replay in several smaller requests. | |
| RETENTION_RECEIPT_BUSY | Wait a few seconds and send the request again. | |
| SAMPLE_EVENT_LIVE | Send it to a Test endpoint, or send webhook.test. | |
| SECRET_UNAVAILABLE | Rotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UNKNOWN_TEMPLATE | Use template ids from GET /api/v1/templates. | |
| UNSAFE_URL | Use a public https URL. | |
| VALIDATION | Fix each field in issues and resend. | |
| WEBHOOK_CAPTURE_NOT_FOUND | List the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures. | |
| WEBHOOK_ENDPOINT_LIMIT | Delete one first. | |
| WEBHOOK_ENDPOINT_NOT_FOUND | Check the id with GET /api/v1/webhook-endpoints. |
/api/v1/webhook-endpoints/{id}/deliveries/{eventId}One delivery with every attempt and the payload sent.
Path
Returns
200 WebhookDeliveryDetail
Errors
| Code | Status | Fix |
|---|---|---|
| CAPTURE_DEVELOPER_ONLY | Make your sandbox in the developer portal and call this in Test mode. | |
| CAPTURE_NOT_STORED | Send the request again. | |
| CAPTURE_TOO_LARGE | Send a smaller body. | |
| CAPTURE_URL_FIXED | Leave the url out, or create a URL endpoint instead. | |
| DELIVERY_PENDING | Wait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying. | |
| EVENT_NOT_FOUND | Check the id with GET /api/v1/scan/events. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_CAPTURE_ENDPOINT | Use a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| REPLAY_NOT_QUEUED | Send the replay request again. | |
| REPLAY_TOO_LARGE | Narrow the time range or replay in several smaller requests. | |
| RETENTION_RECEIPT_BUSY | Wait a few seconds and send the request again. | |
| SAMPLE_EVENT_LIVE | Send it to a Test endpoint, or send webhook.test. | |
| SECRET_UNAVAILABLE | Rotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UNKNOWN_TEMPLATE | Use template ids from GET /api/v1/templates. | |
| UNSAFE_URL | Use a public https URL. | |
| VALIDATION | Fix each field in issues and resend. | |
| WEBHOOK_CAPTURE_NOT_FOUND | List the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures. | |
| WEBHOOK_ENDPOINT_LIMIT | Delete one first. | |
| WEBHOOK_ENDPOINT_NOT_FOUND | Check the id with GET /api/v1/webhook-endpoints. |
/api/v1/webhook-endpoints/{id}/deliveries/{eventId}/replaySends one delivery again with a fresh signature.
Path
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| CAPTURE_DEVELOPER_ONLY | Make your sandbox in the developer portal and call this in Test mode. | |
| CAPTURE_NOT_STORED | Send the request again. | |
| CAPTURE_TOO_LARGE | Send a smaller body. | |
| CAPTURE_URL_FIXED | Leave the url out, or create a URL endpoint instead. | |
| DELIVERY_PENDING | Wait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying. | |
| EVENT_NOT_FOUND | Check the id with GET /api/v1/scan/events. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_CAPTURE_ENDPOINT | Use a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| REPLAY_NOT_QUEUED | Send the replay request again. | |
| REPLAY_TOO_LARGE | Narrow the time range or replay in several smaller requests. | |
| RETENTION_RECEIPT_BUSY | Wait a few seconds and send the request again. | |
| SAMPLE_EVENT_LIVE | Send it to a Test endpoint, or send webhook.test. | |
| SECRET_UNAVAILABLE | Rotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UNKNOWN_TEMPLATE | Use template ids from GET /api/v1/templates. | |
| UNSAFE_URL | Use a public https URL. | |
| VALIDATION | Fix each field in issues and resend. | |
| WEBHOOK_CAPTURE_NOT_FOUND | List the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures. | |
| WEBHOOK_ENDPOINT_LIMIT | Delete one first. | |
| WEBHOOK_ENDPOINT_NOT_FOUND | Check the id with GET /api/v1/webhook-endpoints. |
/api/v1/webhook-endpoints/{id}/replaySends the deliveries in a time range again. dryRun counts without sending.
Path
Body
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| CAPTURE_DEVELOPER_ONLY | Make your sandbox in the developer portal and call this in Test mode. | |
| CAPTURE_NOT_STORED | Send the request again. | |
| CAPTURE_TOO_LARGE | Send a smaller body. | |
| CAPTURE_URL_FIXED | Leave the url out, or create a URL endpoint instead. | |
| DELIVERY_PENDING | Wait for it to send, then check GET /api/v1/webhook-endpoints/{id}/deliveries before replaying. | |
| EVENT_NOT_FOUND | Check the id with GET /api/v1/scan/events. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_CAPTURE_ENDPOINT | Use a capture endpoint: POST /api/v1/webhook-endpoints/capture returns your sandbox's. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| REPLAY_NOT_QUEUED | Send the replay request again. | |
| REPLAY_TOO_LARGE | Narrow the time range or replay in several smaller requests. | |
| RETENTION_RECEIPT_BUSY | Wait a few seconds and send the request again. | |
| SAMPLE_EVENT_LIVE | Send it to a Test endpoint, or send webhook.test. | |
| SECRET_UNAVAILABLE | Rotate the secret with POST /api/v1/webhook-endpoints/{id}/secret, then send the request again. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UNKNOWN_TEMPLATE | Use template ids from GET /api/v1/templates. | |
| UNSAFE_URL | Use a public https URL. | |
| VALIDATION | Fix each field in issues and resend. | |
| WEBHOOK_CAPTURE_NOT_FOUND | List the endpoint's captures with GET /api/v1/webhook-endpoints/{id}/captures. | |
| WEBHOOK_ENDPOINT_LIMIT | Delete one first. | |
| WEBHOOK_ENDPOINT_NOT_FOUND | Check the id with GET /api/v1/webhook-endpoints. |