Developers
Webhooks13

List webhook endpoints

GET/webhooks

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.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Query Parameters

limit?integer

Maximum number of items to return, from 1 to 200.

Range1 <= value <= 200
cursor?string

Cursor for the next page, taken from page.next_cursor of the previous response.

sort?string

Sort order. A leading - sorts in descending order.

Value in

  • "created_at"
  • "-created_at"
status?string

Only endpoints with this status.

Value in

  • "active"
  • "inactive"
event_type?string

Only endpoints subscribed to this event type.

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/webhooks"
{  "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"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Webhooks13

Webhooks in API v3: list webhook endpoints, create a webhook endpoint, list all webhook deliveries, retrieve a webhook endpoint, update a webhook endpoint, delete a webhook endpoint, list deliveries for a webhook endpoint, retrieve a webhook delivery, list delivery attempts, resend a webhook delivery, retrieve a delivery attempt, replay webhook events, rotate a webhook signing secret.

Create a webhook endpoint POST

Creates 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.