Webhook Deliveries

List webhook deliveries

Get paginated list of webhook deliveries with filtering.

get/api/v1/webhook-deliveries

Request

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

Query parameters

pageinteger
Example:1
limitinteger
Example:20
status'pending' | 'delivered' | 'failed'

Delivery status

Example:delivered
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'

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).

Example:verification_request.completed
verification_request_idstring

Filter by verification request

Example:507f1f77bcf86cd799439011

Response

List of webhook deliveries

Example response

{
  "data": [
    {
      "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
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 42,
    "total_pages": 3
  }
}

Changes

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