v3

latestOpenAPI 3.0.0raw.githubusercontent.com2026-06-10283986.5 KB
Webhooks

Get delivery history

get/api/v1/bila/webhooks/{id}/deliveries

Path parameters

idstring required
Example:68f11209-451f-4a15-bfcd-d916eb8b09f4

Webhook config UUID

Query parameters

eventTypestring
Example:payment.completed

Filter by event type

statusstring
Example:DELIVERED

Filter by status (QUEUED, DELIVERED, FAILED, RETRYING)

startDatestring
Example:2026-04-01T00:00:00.000Z

ISO 8601 start of createdAt range (inclusive)

endDatestring
Example:2026-04-30T23:59:59.999Z

ISO 8601 end of createdAt range (inclusive)

pagenumber
Example:1

Page number

perPagenumber
Example:20

Items per page

Response

Deliveries retrieved

statusboolean required

Request success status

messagestring required

Response message

Example response

{
  "status": true,
  "message": "Operation completed successfully",
  "data": {
    "data": [
      {
        "id": "68f11209-451f-4a15-bfcd-d916eb8b09f6",
        "webhookConfigId": "68f11209-451f-4a15-bfcd-d916eb8b09f4",
        "eventType": "payment.completed",
        "payload": {
          "id": "68f11209-451f-4a15-bfcd-d916eb8b09f7",
          "transactionId": "68f11209-451f-4a15-bfcd-d916eb8b09f8",
          "amount": "100.50",
          "status": "COMPLETED"
        },
        "status": "DELIVERED",
        "responseStatus": 200,
        "responseBody": "{\"received\":true}",
        "attempts": 1,
        "maxAttempts": 5,
        "deliveredAt": "2026-04-15T14:30:05.000Z",
        "createdAt": "2026-04-15T14:30:00.000Z"
      }
    ],
    "meta": {
      "total": 150,
      "perPage": 50,
      "currentPage": 1,
      "pageCount": 3
    }
  }
}