Get webhook delivery

GET

GET https://external-api.lia.com.br/external_api/v1/webhook_deliveries/:id

Path Parameters

NameDescriptionRequiredType
idWebhook delivery ID (UUID)trueString

Example request

curl --location 'https://external-api-sandbox.lia.com.br/external_api/v1/webhook_deliveries/f47ac10b-58cc-4372-a567-0e02b2c3d479' \
--header 'Authorization: Bearer YOUR_API_TOKEN'

Example response

{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "entity_id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
  "entity_type": "Payment",
  "webhook_id": "8a7b9c5d-1234-5678-9abc-def012345678",
  "event": "payment.paid",
  "created_at": "2024-05-20T14:30:00.000-03:00",
  "updated_at": "2024-05-20T14:30:05.123-03:00",
  "response_code": 200,
  "request_headers": {
    "Content-Type": "application/json",
    "X-Lia-Signature": "sha256=abc123def456789abcdef0123456789abcdef012345678",
    "User-Agent": "Lia-Webhooks/1.0",
    "Accept": "*/*"
  },
  "request_body": {
    "event": "payment.paid",
    "data": {
      "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
      "amount_cents": 10000,
      "amount_currency": "BRL",
      "status": "paid",
      "payment_method": "pix",
      "paid_at": "2024-05-20T14:29:55.000-03:00",
      "bill_id": "3c4d5e6f-7a8b-9c0d-1e2f-3a4b5c6d7e8f"
    },
    "timestamp": "2024-05-20T14:30:00.000-03:00"
  },
  "response_headers": {
    "Content-Type": "application/json",
    "X-Request-Id": "req_abc123def456",
    "Server": "nginx/1.18.0"
  },
  "response_body": "{\"success\":true,\"message\":\"Webhook received and processed\",\"id\":\"webhook_recv_abc123\"}"
}

Response fields

Request Headers

The request_headers object contains the HTTP headers sent with the webhook delivery:

  • Content-Type: Always application/json
  • X-Lia-Signature: HMAC SHA256 signature for webhook verification
  • User-Agent: Identifies the Lia webhook delivery service

Request Body

The request_body contains the actual webhook payload sent to your endpoint:

  • event: The event type that triggered the webhook
  • data: The entity data related to the event
  • timestamp: When the event occurred

Response Information

  • response_code: HTTP status code returned by your endpoint
  • response_headers: Headers returned by your endpoint
  • response_body: Body content returned by your endpoint

Response codes

CodeDescription
200Successfully retrieved webhook delivery
401Unauthorized - Invalid or missing API token
404Webhook delivery not found

Use cases

This endpoint is useful for:

  • Debugging failed deliveries: Inspect the exact request and response to understand why a webhook failed
  • Verifying delivery: Confirm that a webhook was successfully delivered to your endpoint
  • Monitoring integration: Check response codes and times to monitor webhook reliability
  • Troubleshooting: Review request headers and signature for authentication issues