تخطَّ إلى المحتوى

Webhooks

Webhook endpoint configuration and delivery diagnostics APIs.

v1 · 2026-01-15

GET/webhooks/deliveriesيتطلب مصادقة

List webhook deliveries

Inspect delivery status, attempts, and retry outcomes. Delivery status transitions: `pending` -> `delivered` or `failed`.

المعاملات

الاسمالموضعالنوعمطلوب
endpointIdquerystringلا
eventTypequerystringلا
statusquerystringلا
limitqueryintegerلا
offsetqueryintegerلا

الاستجابات

  • 200Delivery list
  • defaultStandardized API error
GET/webhooks/deliveries/{id}يتطلب مصادقة

Get webhook delivery details

المعاملات

الاسمالموضعالنوعمطلوب
idpathstringنعم

الاستجابات

  • 200Delivery details
  • defaultStandardized API error
POST/webhooks/deliveries/{id}/replayيتطلب مصادقة

Replay a webhook delivery

Create and execute a new delivery attempt for the same event payload.

المعاملات

الاسمالموضعالنوعمطلوب
idpathstringنعم

الاستجابات

  • 200Replay enqueued/sent
  • defaultStandardized API error
GET/webhooks/endpointsيتطلب مصادقة

List webhook endpoints

Webhooks are the recommended lifecycle tracking mechanism. Use polling (`/contracts/{id}/status`) only as a fallback path.

الاستجابات

  • 200Endpoints
  • defaultStandardized API error
POST/webhooks/endpointsيتطلب مصادقة

Create webhook endpoint

جسم الطلب

  • namestringمطلوب
  • urlstringمطلوب
  • eventsarrayمطلوب
  • retryConfigobject

الاستجابات

  • 201Endpoint created
  • defaultStandardized API error
DELETE/webhooks/endpoints/{id}يتطلب مصادقة

Delete webhook endpoint

المعاملات

الاسمالموضعالنوعمطلوب
idpathstringنعم

الاستجابات

  • 200Endpoint deleted
  • defaultStandardized API error
PATCH/webhooks/endpoints/{id}يتطلب مصادقة

Update webhook endpoint

المعاملات

الاسمالموضعالنوعمطلوب
idpathstringنعم

جسم الطلب

  • namestring
  • urlstring
  • eventsarray
  • isActiveboolean
  • retryConfigobject

الاستجابات

  • 200Endpoint updated
  • defaultStandardized API error
POST/webhooks/endpoints/{id}/rotate-secretيتطلب مصادقة

Rotate webhook endpoint secret

المعاملات

الاسمالموضعالنوعمطلوب
idpathstringنعم

الاستجابات

  • 200Secret rotated
  • defaultStandardized API error