Webhooks
Register a webhook endpoint (secret returned once)
POST
/webhooksAuthorization
bearerAuth AuthorizationBearer <token>
In: header
Query Parameters
organization?string
Organization slug (OAuth actors with several orgs); API keys imply theirs.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/webhooks" \ -H "Content-Type: application/json" \ -d '{ "url": "string", "event_types": [ "string" ], "description": "string" }'{ "property1": null, "property2": null}{ "error": { "code": "string", "message": "string", "reason": "string", "index": 0, "request_id": "string" }}{ "error": { "code": "string", "message": "string", "reason": "string", "index": 0, "request_id": "string" }}