ReferenceWebhooks
Register a webhook
Deliveries are signed with HMAC-SHA256 and retried on failure at 1s / 2s / 4s / 8s / 30s, then dead-lettered after five attempts.
The signing secret is returned once, here.
Verify every delivery — see Webhooks for the signature-checking recipe.
Authorization
ApiKeyAuth x-api-key<token>
A platform key (ck_live_…). Mint one in the console under
Settings → API Keys.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/api/v1/webhooks" \ -H "Content-Type: application/json" \ -d '{ "url": "http://example.com", "events": [ "string" ] }'{ "webhook_id": "string", "url": "http://example.com", "events": [ "string" ], "active": true, "created_at": "2019-08-24T14:15:22Z", "secret": "string"}Was this page helpful?Report an issue