Create a webhook endpoint
/webhooksCreates a webhook endpoint that receives events for the subscribed event types.
The destination URL must use HTTPS and point to a public host on port 443, 80, or 8443. Private IP addresses and other non-public destinations are rejected before the endpoint is created. http://localhost is accepted only in sandbox accounts.
The response includes the signing secret. It is returned only once and cannot be retrieved again.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/webhooks" \ -H "Content-Type: application/json" \ -d '{ "event_types": [ "string" ], "url": "http://example.com" }'{ "data": { "created_at": "2019-08-24T14:15:22Z", "description": "string", "event_types": [ "string" ], "health": { "consecutive_failures": 0, "dead_24h": 0, "delivered_24h": 0, "failed_24h": 0, "last_failure_at": "2019-08-24T14:15:22Z", "last_success_at": "2019-08-24T14:15:22Z", "pending": 0 }, "id": "string", "max_per_second": 0, "object": "webhook", "payload_version": 0, "resource_filters": {}, "revision": 0, "secret": "string", "status": "active", "timeout_ms": 0, "updated_at": "2019-08-24T14:15:22Z", "url": "http://example.com" }}List webhook endpoints GET
Returns the webhook endpoints of the current account, paginated by cursor. The collection can be filtered by status and event type. Signing secrets are never included.
List all webhook deliveries GET
Returns webhook deliveries across all webhook endpoints accessible with the current credentials, paginated by cursor. The collection can be filtered by webhook endpoint, status, event type, and creation time.