GET
/
v1
/
webhook
/
history
curl --request GET \
  --url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/webhook/history \
  --header 'apikey: <api-key>' \
  --header 'x-carbon-key: <x-carbon-key>'
{
  "status": "success",
  "message": "data fetched successfully",
  "data": [
    {
      "event_id": "REF-300102",
      "event_type": "account.incoming-transaction",
      "data": {
        "event": "account.incoming-transaction",
        "data": {
          "id": "fd2a1c7e-a17b-477b-8402-734967498369",
          "amount": 100000,
          "currency": "NGN",
          "transactionType": "CREDIT",
          "entryDate": "2024-12-16T13:51:52.759+0000",
          "uniqueRef": "REF-300102",
          "account": {
            "id": "a9a27820-c0d0-4e26-95e1-7625888e9fb9",
            "bankAccount": {
              "accountName": "CARBON BUSINESS DEMO - BRYANA HUELS",
              "accountNumber": "0000000000",
              "bank": {
                "code": "565",
                "name": "CARBON"
              }
            },
            "static": true,
            "currency": "NGN",
            "clientId": "251170382"
          }
        }
      },
      "created_at": "2024-12-16T15:06:13.000Z",
      "updated_at": "2024-12-16T15:06:13.000Z"
    },
    {
      "event_id": "REF-300102_CBN_STAMP_DUTY_CHARGE",
      "event_type": "account.outgoing-transaction",
      "data": {
        "event": "account.outgoing-transaction",
        "data": {
          "id": "d66a39f2-692c-4d19-8098-6bc45fd9f6bf",
          "amount": 50,
          "currency": "NGN",
          "transactionType": "DEBIT",
          "entryDate": "2024-12-16T13:51:55.156+0000",
          "uniqueRef": "REF-300102_CBN_STAMP_DUTY_CHARGE",
          "account": {
            "id": "a9a27820-c0d0-4e26-95e1-7625888e9fb9",
            "bankAccount": {
              "accountName": "CARBON BUSINESS DEMO - BRYANA HUELS",
              "accountNumber": "0000000000",
              "bank": {
                "code": "565",
                "name": "CARBON"
              }
            },
            "static": true,
            "currency": "NGN",
            "clientId": "251170382"
          }
        }
      },
      "created_at": "2024-12-16T14:52:15.000Z",
      "updated_at": "2024-12-16T14:52:15.000Z"
    }
  ],
  "total": 20
}

​
Overview

This endpoint retrieves the history of webhook events with pagination.

​
Request

Method: GET
URL: /v1/webhook/history

​
Parameters

NameInTypeRequiredDescription
x-carbon-keyHeaderstringYesAPI key for authentication.
pageQueryintegerNoPage number for pagination.
limitQueryintegerNoNumber of events per page.

​
Response

Status Code: 200 OK
Content-Type: application/json

​
Example Response

{
  "status": "success",
  "message": "data fetched successfully",
  "data": [
    {
      "event_id": "REF-300102",
      "event_type": "account.incoming-transaction",
      "data": {
        "event": "account.incoming-transaction",
        "data": {
          "id": "fd2a1c7e-a17b-477b-8402-734967498369",
          "amount": 100000,
          "currency": "NGN",
          "transactionType": "CREDIT",
          "entryDate": "2024-12-16T13:51:52.759+0000",
          "uniqueRef": "REF-300102",
          "account": {
            "id": "a9a27820-c0d0-4e26-95e1-7625888e9fb9",
            "bankAccount": {
              "accountName": "CARBON BUSINESS DEMO - BRYANA HUELS",
              "accountNumber": "0000000000",
              "bank": {
                "code": "565",
                "name": "CARBON"
              }
            },
            "static": true,
            "currency": "NGN",
            "clientId": "251170382"
          }
        }
      },
      "created_at": "2024-12-16T15:06:13.000Z",
      "updated_at": "2024-12-16T15:06:13.000Z"
    },
    {
      "event_id": "REF-300102_CBN_STAMP_DUTY_CHARGE",
      "event_type": "account.outgoing-transaction",
      "data": {
        "event": "account.outgoing-transaction",
        "data": {
          "id": "d66a39f2-692c-4d19-8098-6bc45fd9f6bf",
          "amount": 50,
          "currency": "NGN",
          "transactionType": "DEBIT",
          "entryDate": "2024-12-16T13:51:55.156+0000",
          "uniqueRef": "REF-300102_CBN_STAMP_DUTY_CHARGE",
          "account": {
            "id": "a9a27820-c0d0-4e26-95e1-7625888e9fb9",
            "bankAccount": {
              "accountName": "CARBON BUSINESS DEMO - BRYANA HUELS",
              "accountNumber": "0000000000",
              "bank": {
                "code": "565",
                "name": "CARBON"
              }
            },
            "static": true,
            "currency": "NGN",
            "clientId": "251170382"
          }
        }
      },
      "created_at": "2024-12-16T14:52:15.000Z",
      "updated_at": "2024-12-16T14:52:15.000Z"
    }
  ],
  "total": 20
}

Authorizations

​
apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

​
x-carbon-key
string
required

Query Parameters

​
page
integer
​
limit
integer

Response

200 - application/json
OK

The response is of type object.