Skip to main content
GET
Retrieve a webhook delivery

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

200 - application/json

Serializer for WebhookDelivery model.

id
string<uuid>
required
read-only
webhook_url
string
required
read-only
event_type
enum<string>
required
  • mandate.created - Mandate Created
  • mandate.updated - Mandate Updated
  • mandate.status_updated - Mandate Status Updated
  • mandate.closed - Mandate Closed
  • mandate.transferred - Mandate Transferred to Ikaros
  • mandate.balance_updated - Mandate Balance Updated
  • mandate.message_created - Mandate Message Created
  • claim.created - Claim Created
  • claim.released - Claim Released for Processing
  • claim.updated - Claim Updated
  • payment.created - Payment Reported
  • payment.updated - Payment Updated
  • statement.created - Statement Created
  • statement.updated - Statement Updated
  • single_mandate_statement.created - Single-Mandate Statement Created
  • single_mandate_statement.updated - Single-Mandate Statement Updated
  • request_to_client.created - Request to Client Created
  • request_to_client.answered - Request to Client Answered
Available options:
mandate.created,
mandate.updated,
mandate.status_updated,
mandate.closed,
mandate.transferred,
mandate.balance_updated,
mandate.message_created,
claim.created,
claim.released,
claim.updated,
payment.created,
payment.updated,
statement.created,
statement.updated,
single_mandate_statement.created,
single_mandate_statement.updated,
request_to_client.created,
request_to_client.answered
payload
any
required
read-only

The JSON payload sent to the webhook endpoint

status
enum<string>
required
  • pending - Pending
  • success - Success
  • failed - Failed
  • retrying - Retrying
Available options:
pending,
success,
failed,
retrying
attempts
integer
required
read-only

Number of delivery attempts made

response_status_code
integer | null
required
read-only
response_body
string
required
read-only

Response body from webhook endpoint (truncated)

error_message
string
required
read-only

Error message if delivery failed

idempotency_key
string
required
read-only

Unique key to prevent duplicate deliveries

created
string<date-time>
required
read-only

When this delivery was first created

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

Timestamp of the most recent delivery attempt

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

Scheduled time for next retry attempt

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

When delivery was successfully completed or permanently failed