Webhooks

Get a webhook

get/client/webhooks/{id}

Authorization

Bearer token in the Authorization header.

Path parameters

idstringrequired

Response

idstringrequired

organizationIdstringrequired

urlstringrequired

eventsstring[]required

statusstringrequired

Options: activeinactivefailed

createdAtstringrequired

updatedAtstringrequired

Request

curl -X GET 'https://api.lira.com/api/v1/client/webhooks/{id}' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

const response = await fetch('https://api.lira.com/api/v1/client/webhooks/{id}', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
  },
});

const data = await response.json();

import requests

response = requests.get(
    "https://api.lira.com/api/v1/client/webhooks/{id}",
    headers={"Authorization": "Bearer YOUR_ACCESS_TOKEN"},
)

data = response.json()

Response

{
  "id": "b8c9d0e1-f2a3-4567-bcde-890123456789",
  "organizationId": "d4e5f6a7-b8c9-0123-defa-456789012345",
  "url": "https://yourapp.com/webhooks/lira",
  "events": [
    "verification.completed",
    "verification.failed"
  ],
  "status": "active",
  "createdAt": "2026-04-22T10:15:30.000Z",
  "updatedAt": "2026-04-22T10:15:30.000Z"
}

{
  "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."
  }
}