Skip to main content
GET
Get webhook delivery

Authorizations

Authorization
string
header
required

Company-bound Case Management API key — the standard credential for this API.

Headers

X-On-Behalf-Of-Company
string<uuid>

Required when a Partner key calls the Case Management API; rejected for direct Case keys. Contains the entitled paywise company UUID.

If-None-Match
string

Return 304 with an empty body when the current ETag matches one of the supplied validators (or *).

Path Parameters

id
string<uuid>
required

UUID of the webhook delivery in this request.

Response

Read view of a single delivery attempt (all fields read-only).

attempts
integer
required
read-only

Number of delivery attempts made so far.

completed_at
string<date-time> | null
required
read-only

Time at which delivery succeeded or stopped retrying.

created_at
string<date-time>
required
read-only

Time at which the delivery was queued.

error_message
string
required
read-only

Latest failure reason, such as an HTTP error, transport error, disabled or blocked endpoint, or expired retry window. Empty when no failure reason is recorded.

event_id
string<uuid>
required
read-only

Stable identifier of the event, shared by deliveries to different endpoints and by manual redeliveries. Use this ID to deduplicate event processing.

event_type
string
required
read-only

Business event being delivered.

id
string<uuid>
required
read-only

Stable identifier of this delivery.

idempotency_key
string
required
read-only

Key identifying this delivery record. A manual redelivery receives a new key while preserving event_id; deduplicate business-event processing with event_id.

last_attempt_at
string<date-time> | null
required
read-only

Time of the most recent delivery attempt.

next_retry_at
string<date-time> | null
required
read-only

Scheduled time of the next retry, when applicable.

payload
Order lifecycle event · object
required

Exact event body sent to the webhook endpoint.

Example:
request_id
string<uuid> | null
required
read-only

Request that originally caused the event, when available.

response_body
string
required
read-only

Most recently recorded HTTP response body, truncated to at most 4096 UTF-8 bytes. Empty when no body is retained.

response_status_code
integer | null
required
read-only

Latest HTTP status returned by the destination.

status
string
required
read-only

Delivery state: pending (queued), delivering (attempt in progress), retrying (waiting for another attempt), success (delivered), or failed (automatic delivery stopped).

updated_at
string<date-time>
required
read-only

Time at which the delivery record last changed.

webhook
string<uuid>
required
read-only

Webhook subscription targeted by the delivery.

webhook_url
string
required
read-only

Current URL configured on the targeted webhook subscription.