Skip to main content
GET
Get webhook delivery

Authorizations

Authorization
string
header
required

Partner API Bearer key: Authorization: Bearer <key>. Keys are created only through authorized portal or staff flows.

Headers

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

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

Most recent delivery failure detail, including HTTP errors, transport failures, blocked destinations, or retry-window expiry. Empty after success or response-log retention cleanup.

event_id
string<uuid>
required
read-only

Stable event identifier shared by deliveries to different endpoints and by manual redeliveries of the same event.

event_type
string
required
read-only

Partner lifecycle, Case Management, or Mahnservice event type being delivered.

id
string<uuid>
required
read-only

Stable identifier of this delivery.

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
Company created · 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 response body, truncated to at most 4096 UTF-8 bytes. Empty if unavailable or removed by the 30-day response-log retention cleanup.

response_status_code
integer | null
required
read-only

Most recently recorded HTTP status from the destination, or null if no response has been recorded or retained response logs were purged. A later transport failure can leave the previous status unchanged.

status
string
required
read-only

Delivery state: pending (queued), delivering (attempt in progress), retrying (another automatic attempt scheduled), success, or failed (no automatic retry remains).

updated_at
string<date-time>
required
read-only

Time at which the delivery record last changed.