Developers
API referenceBusiness sign in

Webhooks

Webhook endpoints of this API client

GET/webhook-endpoints

Scope webhooks.readLIVE keys only

Webhook endpoints of this API client

Request

No parameters.

Response

Success responses
StatusMeaning
200Endpoints and supported events

The body is { "status": "success", "data": … }. Fields of data (WebhookEndpointList):

Response data
FieldTypeDescription
endpointsRequiredarray of WebhookEndpoint
supportedEventsRequiredarray of WebhookEventName
reservedEventsOptionalarray of string

Errors

Errors use the error envelope { "status": "error", "message", "code"?, "details"? }.

Error responses
StatusWhen
401Missing, invalid, expired or revoked API key. The API key is missing, invalid, expired or revoked.
403The key lacks the scope, or the operation needs a LIVE key. The key lacks the scope, or this call needs a LIVE key (LIVE_KEY_REQUIRED), or the Business owner is not verified (SENDER_VERIFICATION_REQUIRED).
429Too many requests. See the RateLimit headers. Too many requests. Wait for Retry-After, then retry with the same idempotency key.