Webhook Deliveries

List deliveries for a webhook

get/client/webhooks/{webhookId}/deliveries

List delivery attempts for a webhook, newest first.

Authorization

API key in the X-API-Key header.

Path parameters

webhookIdstringrequired

The webhook to list deliveries for

Query parameters

statusstring

Filter by delivery status: pending, success, or failed

Options: pendingsuccessfailed

Request

curl -X GET 'https://api.uselira.com/api/v1/client/webhooks/{webhookId}/deliveries' \
  -H 'X-API-Key: YOUR_API_KEY'

const response = await fetch('https://api.uselira.com/api/v1/client/webhooks/{webhookId}/deliveries', {
  method: 'GET',
  headers: {
    'X-API-Key': 'YOUR_API_KEY',
  },
});

const data = await response.json();

import requests

response = requests.get(
    "https://api.uselira.com/api/v1/client/webhooks/{webhookId}/deliveries",
    headers={"X-API-Key": "YOUR_API_KEY"},
)

data = response.json()

Response

[
  {
    "id": "c9d0e1f2-a3b4-5678-cdef-901234567890",
    "webhookId": "b8c9d0e1-f2a3-4567-bcde-890123456789",
    "verificationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "status": "success",
    "attempts": 1,
    "lastAttemptAt": "2026-04-22T10:15:31.500Z",
    "payload": {
      "event": "verification.completed",
      "verificationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "status": "success",
      "timestamp": "2026-04-22T10:15:30.000Z"
    },
    "response": {
      "statusCode": 200,
      "body": "OK"
    },
    "createdAt": "2026-04-22T10:15:30.000Z",
    "updatedAt": "2026-04-22T10:15:31.500Z"
  }
]

{
  "message": "NG Account Number verification is not enabled for your organisation.",
  "code": "SERVICE_NOT_ENABLED",
  "action": {
    "type": "CONTACT_ADMIN",
    "hint": "Ask your administrator to enable NG Account Number verification in the Lira dashboard."
  }
}