'/%3e%3cdefs%3e%3cpattern%20id='pattern0_2104_4598'%20patternContentUnits='objectBoundingBox'%20width='1'%20height='1'%3e%3cuse%20xlink:href='%23image0_2104_4598'%20transform='matrix(0.00376176%200%200%200.0172414%20-0.00219436%200)'/%3e%3c/pattern%3e%3cimage%20id='image0_2104_4598'%20width='267'%20height='58'%20preserveAspectRatio='none'%20xlink:href='data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQsAAAA6CAMAAACQ2ozcAAAAM1BMVEVMaXH////////////////////////////////////////////////////////////////x7/yuAAAAEHRSTlMAoDDgEPBgwIBAINCwkHBQDIOTDwAAAAlwSFlzAAFxGAABcRgB7MGwCAAABm1JREFUaIHlW+uWsyoMLSIIeH3/pz0CKrmgQuusdn0nf2YaMW42kISgr1cQK+SySj+61/9cmm45RLTfRvNV0WoBIptv4/mi6AWLuiVDd0lKmLPGGPsA0nelGG8TZoXU69poTPi/v1smBjB338dZxvk218B/VIrxBl8hth9t73+Zp2x7SdNuLMX+tJTitZCKjQx1MzFquLBVc+hvpBSv8NMX/Hb+Bv2MbS8DaNsVYn9aSvFK2nWB5slHtr0sUL4Ur0vx+usowdL3A1jBhUVcfGmR1HCBFPbvuWhskvuefC4/wkWbWyMgzV2ub39GarhA+cf0KBevHrTdffSvcuGxonzCA73JBGq4gFnt7qN/lYtxwflEWOA3KWJVriWOpkd0+lUuQj6Rsu6QkcuL9jW2o4xbyzTZfpWLOG79FlatgnP5Y9tRnFn3RAYE7p/loo1bJ6GtnSLIYbuwRrz8rq6SCyY/y8W2UU0SFkw7xQCghszN/y4Xr0ZCKjpPxQz46Vjdj9pupiHUBsxclmRXcOG0CKZHfVV9dHqM1QmRrZNU4IVN15kwQ98fNHSlYNsaUsmmEUw899gNuQCck2ur17KwZXcypM6gsVSCtSN4YcozzLmWqtvbNCPRUDKgbU07RiC/z8XgmOnMtHNiYUJZu8Tbg8YW3B6HOK6PwRPQRo1sT21nBGVq73OxKNaElx8n3iiAR4CL8YbOHlH0YHnXtAL2osg2Gr8PuMgIIaPNTIooqIJdijfkyFO6b6u9gBTDo1M1PKOK6bNcYCBtf9Gwqcc7LHgr1qqFaHil69Y2KAY9zMWe/Ny3BWSU4vVdZ3UtvCHxGuQD7m2nmfY0FyBBGK8bJidXitf/gxbA7DVQwStdBbbVng48zsUxMexdy7EWr/8H9dw/QjJNLRfHKnmci2Pk5G1LW4nX/2U9x5p5eYOLvYj6PBfb+qXHfacWy/H6P6yuhavBfl1Cl0VtK7MaaGcS30wZF6ny2WS4kD71ttjyZgXHEDk5j4Ew2dTh9SbREYCEqA/NBBXY9pHX4E2eLOPiRQT1RsDAv0sc7QZhOHowIwxjHd4wDcDEmCJ1jmjQREG2werBxt3HXKRIwE+cEAYwmMijygze/hxvrq6FNJp0mNp2Zxf0x1ykWD8zLmA7lIChqe+u8U4Eb2goLbjYSaCJdnDqC20jR4JOAMzHXADYjAs4pCj5QYvH3uCFVjy66IR6Y8zoSfDlPr1rhEKdyHCB64GwJ8PHXAA144L3eBcYaw3DixwfW3skqw+GcUpHj1fP60TwSveXXKDRP7fAubjBi2bKwnrAT5p/gAsEEFuA41jNBQ60YZEip8Lq4r/NBexOLRfbvX0XfGZY5i5uVjcNOzs6tz0S23/GhYNctKcWKrmI4Sq+2BlebpRm9FSY8IRYcVTndS3si6DrEX/JBfKdeKjgitcMLw4DxNf7oVcHW/viSLt/kfqV46KHF9BofR5Tr7iA0QKhg6lIJqZe4Q3hExAroJEgIe6c17XgpEOeZy7ighatS7mA0RDlTyiJr8Obr2sJqjmva4H1g7eObREXNEiVcoGeBWqKuXy7FG9kBEhwfyjPZG9wkQOVfJlgS/Bu9+wbyy5z7YoLNL2XfgNMisFTBd6+qH5xW9fqjbV6JLUVfc4FzuS6yVoz3Lyzw7jAi2SlfrWiBTkhaOvwZrnomaa6lrNPxRwX2ft1JRe3Jb40mUvxkmc+Vtcy0NyFjgIv5oJOjEz39nVXitf/Rb6c+4txufQXWTkqpjkuXrnDLlnLhcsfmSU5Up9SvP7ZvK7F4shFXSsrB5lZLrLHXbzGd80FziS4pN15Kd6QXIGJYUhftolyXtfKSgrBWS5c7p6plguyayJyFmcv8IZRT1nmHnKJ5jzvzAoormS5yFoYqrm4AgI//LjFu3cvkKvioLQp2qlIlQseSuEXQYDt7JqFiVmei+wqqeeCfBIFewcT5XK80R+rwZgNx/F60qEhm3Zgu+HHuxK54hMucmTYei5e7B2NCD37hknAy9tDvPS0WjDNef1iTUQMploZvKc942L/3Aj0sXmDi9UOGw0KoQovzAPD2miRhr35mr7fCo3BO0K9pq/ONOBbL03NpIfIcXNQI2gP2gIteym5gSmkGvgbmRd4J/aqj93zFiUc1VCSc+K0WWWytd+HtHZ678YTQ2Yu+4jSzVePbcNVe6n51+U/wZKesx3N5aEAAAAASUVORK5CYII='/%3e%3c/defs%3e%3c/svg%3e)
Overview
Webhooks deliver platform notifications to an HTTPS endpoint you control. Use the /webhooks endpoints to register and manage endpoints, /webhooks/event-types to discover the events you can subscribe to, and /webhooks/events to list, inspect, and retry the deliveries those endpoints receive. The signing secret is returned once at creation — use it to verify the signature on every delivery.
- List webhooksGET/webhooks
- Create webhookPOST/webhooks
- Get webhookGET/webhooks/:id
- Update webhookPATCH/webhooks/:id
- Delete webhookDELETE/webhooks/:id
- Rotate signing secretPOST/webhooks/:id/rotate-secret
- List event typesGET/webhooks/event-types
- List delivery eventsGET/webhooks/events
- Get delivery eventGET/webhooks/events/:id
- Retry delivery eventPOST/webhooks/events/:id/retry
List Webhooks
Use Case
Returns a paginated list of webhook endpoints registered for the organization.
Query Parameters
Opaque cursor — pass `next_cursor` from a prior response to fetch the next page.
Opaque cursor for reverse pagination.
Page size; bounded by the endpoint maximum.
Create Webhook
Use Case
Registers a new webhook endpoint for platform notifications. The signing secret is returned once at creation time; subsequent reads do not include it. Pass event_types to filter to a subset, or omit it to receive every event the platform emits.
Request Body
Display name for the endpoint.
HTTPS endpoint that will receive delivery events.
Event types to subscribe to. Omit to receive every event the platform emits. See the List Event Types endpoint for the canonical list.
Pass an optional Idempotency-Key header (1–255 printable ASCII chars) to safely retry creation. The same key with the same body returns the cached response; the same key with a different body returns 409.
Get Webhook
Use Case
Returns a single webhook endpoint by ID.
Get Webhook Response
Unique identifier for the webhook endpoint.
Resource type identifier. Always `webhook`.
Display name given to the endpoint when it was created.
HTTPS endpoint that receives delivery events.
Lifecycle status of the endpoint (e.g. `active`).
Event types this endpoint is subscribed to. See the List Event Types endpoint for the full catalog.
Whether a signing secret is configured. The plaintext secret is never returned on reads — only at creation and on rotation.
RFC 3339 timestamp of the most recent delivery attempt. Omitted entirely until the endpoint is first triggered.
RFC 3339 timestamp of when the endpoint was created.
RFC 3339 timestamp of the most recent change.
Update Webhook
Use Case
Partially updates a webhook endpoint's url, name, or event_types filter. Only the fields you supply are changed.
Request Body
Updated display name.
Updated HTTPS endpoint.
Updated event-type filter. Replaces the existing set.
Update Webhook Response
Returns the full webhook object with your changes applied. updated_at advances to the time of the change; signing_secret is not included.
Unique identifier for the webhook endpoint.
Resource type identifier. Always `webhook`.
Display name after the update.
HTTPS endpoint after the update.
Lifecycle status of the endpoint (e.g. `active`).
Event-type filter after the update.
Whether a signing secret is configured. The plaintext secret is never returned on update.
RFC 3339 timestamp of when the endpoint was created. Unchanged by updates.
RFC 3339 timestamp of this change.
Delete Webhook
Use Case
Soft-deletes a webhook endpoint. Subsequent platform events will not be delivered to its URL.
Response: 204 No Content — empty body.
Rotate Signing Secret
Use Case
Generates a new HMAC signing secret for this webhook. The new secret is returned once — store it before the response closes.
Rotate Signing Secret Response
Resource type identifier. Always `signing_secret`.
The new HMAC signing secret. Returned only on this response — store it before the response closes.
List Event Types
Use Case
Returns the canonical list of all platform event types that can be delivered to webhook endpoints. Use these values in the event_types filter when creating or updating a webhook.
Event Type Object
The event type identifier to use in an `event_types` filter (e.g. `transaction.confirmed`).
Grouping the event belongs to: `wallet`, `security`, or `compliance`.
Human-readable name for the event.
What triggers this event.
List Delivery Events
Use Case
Returns a paginated list of platform notification deliveries across all webhook endpoints, newest first. Filter to a single endpoint with webhook_id, or by delivery status.
Query Parameters
Opaque cursor — pass `next_cursor` from a prior response to fetch the next page.
Opaque cursor for reverse pagination.
Page size; bounded by the endpoint maximum.
Filter by delivery status: `pending`, `delivered`, or `failed`.
Narrow the listing to a single webhook endpoint.
Get Delivery Event
Use Case
Returns a single delivery event by ID. The event must belong to a webhook owned by the caller's organization.
Get Delivery Event Response
The payload is a single WebhookEventResponse — the same object documented under List Delivery Events. Refer there for the per-field explanations.
Retry Delivery Event
Use Case
Re-queues the specified platform notification delivery for another attempt. Useful for re-delivering events that previously failed. Org ownership is enforced via the delivery's parent webhook.
Retry Delivery Event Response
Resource type identifier.
Result of the re-queue request (e.g. `queued`).