Webhook Deliveries

Get webhook delivery

Get details of a specific webhook delivery including payload and response.

get/api/v1/webhook-deliveries/{id}

Request

  • Base URL: https://api.proof.holdings
  • URL: https://api.proof.holdings/api/v1/webhook-deliveries/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

MongoDB ObjectId

Example:507f1f77bcf86cd799439011

Response

Webhook delivery details

idstring required

MongoDB ObjectId

verification_request_idstring required

MongoDB ObjectId

event_type'verification_request.completed' | 'verification_request.partial' | 'verification_request.expired' | 'verification.completed' | 'confirmation.approved' | 'confirmation.denied' | 'authorization.approved' | 'authorization.denied' | 'proof.revoked' | 'proof.suspended' | 'proof.unsuspended' | 'account.deletion_scheduled' | 'account.deletion_cancelled' required

Type of webhook event. proof.suspended/proof.unsuspended fire for a delegation (ph_dlg_*) lifecycle act on the account's own configured webhook_url — not a channel to a separately-addressed delegate (h-fix-delegation-suspend-governance).

urlstring uri required
status'pending' | 'delivered' | 'failed' required

Delivery status

attemptsinteger required
max_attemptsinteger required
last_attempt_atstring date-time nullable required
next_retry_atstring date-time nullable required
delivered_atstring date-time nullable required
response_statusinteger nullable required
error_messagestring nullable required
created_atstring date-time required
payloadobject

The event body that was POSTed. Absent for an API key bound to one sub-account: a delivery does not yet record its sub-account, so the body may be another sub-account's record.

response_bodystring nullable required

The receiver's response body. Null for an API key bound to one sub-account, for the same reason as payload.

updated_atstring date-time required

Example response

{
  "id": "507f1f77bcf86cd799439011",
  "verification_request_id": "507f1f77bcf86cd799439011",
  "event_type": "verification_request.completed",
  "url": "https://yourapp.com/webhook",
  "status": "delivered",
  "attempts": 1,
  "max_attempts": 6,
  "response_status": 200
}

Changes

No recorded changes to this operation across all 1 revision of this API.