Create a webhook endpoint
X-Api-Key<token>
Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.
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/webhooks" \ -H "Content-Type: application/json" \ -d '{ "url": "https://hooks.zapier.com/hooks/catch/123456/abcdef/", "events": [ "document.finalized", "payment.received" ] }'{ "id": "string", "businessId": "string", "url": "string", "description": "string", "events": [ [] ], "isActive": true, "headers": {}, "maxRetries": 0, "createdByUserId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "deliveryStats": { "total": 42, "delivered": 38, "failed": 2, "pending": 2 }}