Webhook endpoint configuration and delivery diagnostics APIs.
GET/webhooks/deliveriesRequires authentication
List webhook deliveries
Inspect delivery status, attempts, and retry outcomes.
Delivery status transitions: `pending` -> `delivered` or `failed`.
Parameters
| Name | In | Type | Required |
|---|
| endpointId | query | string | No |
|---|
| eventType | query | string | No |
|---|
| status | query | string | No |
|---|
| limit | query | integer | No |
|---|
| offset | query | integer | No |
|---|
Responses
200Delivery listdefaultStandardized API error
GET/webhooks/deliveries/{id}Requires authentication
Get webhook delivery details
Parameters
| Name | In | Type | Required |
|---|
| id | path | string | Yes |
|---|
Responses
200Delivery detailsdefaultStandardized API error
POST/webhooks/deliveries/{id}/replayRequires authentication
Replay a webhook delivery
Create and execute a new delivery attempt for the same event payload.
Parameters
| Name | In | Type | Required |
|---|
| id | path | string | Yes |
|---|
Responses
200Replay enqueued/sentdefaultStandardized API error
GET/webhooks/endpointsRequires authentication
List webhook endpoints
Webhooks are the recommended lifecycle tracking mechanism.
Use polling (`/contracts/{id}/status`) only as a fallback path.
Responses
200EndpointsdefaultStandardized API error
POST/webhooks/endpointsRequires authentication
Create webhook endpoint
Request body
namestringrequiredurlstringrequiredeventsarrayrequiredretryConfigobject
Responses
201Endpoint createddefaultStandardized API error
DELETE/webhooks/endpoints/{id}Requires authentication
Delete webhook endpoint
Parameters
| Name | In | Type | Required |
|---|
| id | path | string | Yes |
|---|
Responses
200Endpoint deleteddefaultStandardized API error
PATCH/webhooks/endpoints/{id}Requires authentication
Update webhook endpoint
Parameters
| Name | In | Type | Required |
|---|
| id | path | string | Yes |
|---|
Request body
namestringurlstringeventsarrayisActivebooleanretryConfigobject
Responses
200Endpoint updateddefaultStandardized API error
POST/webhooks/endpoints/{id}/rotate-secretRequires authentication
Rotate webhook endpoint secret
Parameters
| Name | In | Type | Required |
|---|
| id | path | string | Yes |
|---|
Responses
200Secret rotateddefaultStandardized API error