Register a webhook endpoint; the signing secret is returned once
Registers a tenant-wide webhook endpoint.
/v1/webhook_endpointsRegisters a tenant-wide webhook endpoint. The signing secret is returned in this response and nowhere else — store it now, because there is no call that reads it back. event_filters narrows what is delivered; omit it to receive every event type. Requires webhooks:manage; a missing body or a URL the service will not accept gives invalid_request (400).
Authorization
bearerAuth A tenant API key (sk_{env}_{id}_{secret}), a wallet user token, or an IdP access token. Which principal the credential resolves to decides the scopes it carries; see the authentication guide.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/v1/webhook_endpoints" \ -H "Content-Type: application/json" \ -d '{ "url": "http://example.com" }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643", "url": "string", "event_filters": [ "string" ], "status": "string", "secret": "string", "created_at": "2019-08-24T14:15:22Z"}