Skip to main content
POST
curl

Authorizations

Authorization
string
header
required

Partner API key sent as Authorization: Bearer . Test keys and live keys are separate.

Headers

Idempotency-Key
string

Accepted but not used for replay on this operation. Only POST /v1/partner/consultations stores and replays responses by Idempotency-Key.

Pattern: ^[A-Za-z0-9_-]{8,128}$

Path Parameters

delivery_id
string<uuid>
required

The webhook delivery id.

Response

The re-queued delivery.

id
string<uuid>
required

The delivery id.

object
enum<string>
required

Always webhook_delivery.

Available options:
webhook_delivery
endpoint_id
string<uuid>
required

The webhook endpoint the delivery is for.

event_id
string<uuid>
required

The event id. A replay keeps the same id; use it to deduplicate.

event_type
string
required

The event type, for example consultation.approved.

status
enum<string>
required

pending, succeeded, failed or exhausted.

Available options:
pending,
succeeded,
failed,
exhausted
attempt_count
integer
required

Delivery attempts made so far.

next_attempt_at
string<date-time>
required

When the next attempt is due. Never null: it keeps the last scheduled time after a success or once retries are exhausted.

last_attempt_at
string<date-time> | null
required

When the last attempt was made; null before the first attempt.

delivered_at
string<date-time> | null
required

When the endpoint accepted the delivery; null until then.

response_status
integer | null
required

HTTP status your endpoint returned on the last attempt; null if none was received.

response_excerpt
string
required

The start of your endpoint's last response body; an empty string when none.

error
string
required

Why the last attempt failed; an empty string when it did not fail.

created_at
string<date-time>
required

When the delivery was queued.