Webhook Deliveries

{
  "id": "811f4c9e-d818-4e07-bfbc-fb0aa73ab82f",
  "webhookId": "cmjh39i5x0000v814e7owtybc",
  "event": "payment.failed",
  "transactionId": "cmjfu1cjv0003v8vsmmxgjk05",
  "payload": {
    "event": "payment.failed",
    "data": {
      "transactionId": "cmjfu1cjv0003v8vsmmxgjk05",
      "amount": 4000,
      "currency": "NGN",
      "status": "failed"
    }
  },
  "status": "COMPLETED",
  "attemptCount": 2,
  "responseStatus": "200",
  "nextRetryAt": null,
  "createdAt": "2025-12-24T10:42:37.231Z",
  "lastAttemptAt": "2025-12-24T10:43:40.347Z"
}

The delivery object

A webhook delivery represents a single attempt to send an event payload to your registered endpoint. Each delivery tracks the payload, status, and retry information.

string

Unique identifier for the delivery attempt.

string

Webhook configuration that triggered this delivery.

string

Event type that caused the delivery (e.g. payment.success).

string

Transaction associated with this webhook event.

object

The exact JSON payload sent to your endpoint. Stored for debugging and replay.

string

Delivery status. One of PENDING, COMPLETED, or FAILED.

number

Number of delivery attempts made.

string

HTTP status code returned by your endpoint (e.g. 200, 500, timeout). Null if no response received.

datetime

Scheduled time for the next retry, if the delivery failed. Null on success.

datetime

When the delivery record was created.

datetime

Timestamp of the most recent delivery attempt.

{
  "id": "811f4c9e-d818-4e07-bfbc-fb0aa73ab82f",
  "webhookId": "cmjh39i5x0000v814e7owtybc",
  "event": "payment.failed",
  "transactionId": "cmjfu1cjv0003v8vsmmxgjk05",
  "payload": {
    "event": "payment.failed",
    "data": {
      "transactionId": "cmjfu1cjv0003v8vsmmxgjk05",
      "amount": 4000,
      "currency": "NGN",
      "status": "failed"
    }
  },
  "status": "COMPLETED",
  "attemptCount": 2,
  "responseStatus": "200",
  "nextRetryAt": null,
  "createdAt": "2025-12-24T10:42:37.231Z",
  "lastAttemptAt": "2025-12-24T10:43:40.347Z"
}

List deliveries

GET /webhook/deliveries

Returns webhook delivery history for the authenticated profile. Use query parameters to filter by status, event type, transaction, or date range.

Query parameters

string

Filter by delivery status. One of PENDING, COMPLETED, FAILED.

string

Filter deliveries for a specific transaction.

string

Filter by event type. e.g. payment.success, payment.failed.

string

JSON-encoded date range filter. Example: {"startDate":"2024-01-01","endDate":"2024-01-31"}. Partial ranges (start only or end only) are supported.

curl -X GET "https://api.orafi.app/webhook/deliveries?status=FAILED&event=payment.failed" \
  -H "x-api-key: ora_test_your_api_key"

const params = new URLSearchParams({
  status: "FAILED",
  event: "payment.failed"
});

const response = await fetch(
  `https://api.orafi.app/webhook/deliveries?${params}`,
  { headers: { "x-api-key": "ora_test_your_api_key" } }
);

import requests

response = requests.get(
    "https://api.orafi.app/webhook/deliveries",
    headers={"x-api-key": "ora_test_your_api_key"},
    params={"status": "FAILED", "event": "payment.failed"}
)

{
  "success": true,
  "message": "Webhook deliveries retrieved successfully!",
  "data": [
    {
      "id": "811f4c9e-d818-4e07-bfbc-fb0aa73ab82f",
      "webhookId": "cmjh39i5x0000v814e7owtybc",
      "event": "payment.failed",
      "transactionId": "cmjfu1cjv0003v8vsmmxgjk05",
      "payload": {
        "event": "payment.failed",
        "data": {
          "transactionId": "cmjfu1cjv0003v8vsmmxgjk05",
          "amount": 4000,
          "currency": "NGN",
          "status": "failed",
          "occuredAt": "2025-12-24T10:42:36.842Z"
        }
      },
      "status": "COMPLETED",
      "attemptCount": 2,
      "responseStatus": "200",
      "nextRetryAt": null,
      "createdAt": "2025-12-24T10:42:37.231Z",
      "lastAttemptAt": "2025-12-24T10:43:40.347Z"
    }
  ]
}

Overview

Transactions

Payments

Refunds

Payouts

Paylinks

Customers

Subscriptions

Webhooks