This API retrieves a list of all webhook events that have been triggered and sent. The response provides detailed information for each webhook event, including the URL, response, timestamp, and payload details. Pagination options are available to efficiently handle large datasets.

This route is secured with processor and vendor token authentication.

​
Endpoint

GET   /3p/api/v2/webhook-events

​
Query Parameter

FieldsTypeIs RequiredDescription
per_pageintegerNoBy default: 10 Min: 1 Max: 100
start_datestringNoThis parameter will filter the user’s records based on the notifying date of the event. Date format: Y-m-d
end_datestringNoThis parameter will filter the user’s records based on the notifying date of the event. Date format: Y-m-d
sort_orderstringNoBy default: newest Possible Value: newest oldest
event_namestringNoPossible Values: TransactionStarted TransactionCaptureStarted TransactionCompleted TransactionFailed TransactionCanceled PayoutOnHold PayoutCompleted ClawbackStarted ClawbackFailed ClawbackCompleted BankLinkedSuccessfully BankLinkFailed BusinessCreated BusinessUpdated BatchPayout RefundPending RefundCaptureStarted RefundCaptureCompleted RefundCaptureFailed RefundPayoutPending RefundPayoutCompleted RefundPayoutFailed BatchRefund
pageintegerNoBy default: 1 Min: 1

​
Response

{
    "status": true,
    "message": "",
    "data": {
        "webhook_events": [
            {
                "event": "TransactionStarted",
                "webhook_url": "https://...",
                "webhook_payload": {
                    "type": "api",
                    "uuid": "9d1a47df-32b6-43f1-af02-98006171fdfb",
                    "event": "TransactionStarted",
                    "amount": 9900,
                    "status": "CAPTURE_PENDING",
                    "currency": "USD",
                    "created_at": "2024-09-26 14:46:45",
                    "payee_uuid": "9d1a4762-b676-49c4-8ef2-76915537cc49",
                    "payer_uuid": "9d1a3eb3-3bae-45ed-b164-3e60e6030a13",
                    "updated_at": "2024-09-26 14:46:45",
                    "payout_status": null,
                    "capture_status": "CAPTURE_PENDING",
                    "clawback_status": null,
                    "transaction_fee": 0,
                    "payout_delay_days": 2,
                    "client_reference_id": "debit_4578"
                },
                "webhook_response": {
                    "status": true,
                    "status_code": 200
                },
                "date": "2024-09-26 14:48:46"
            },
            {
                "event": "PayoutCompleted",
                "webhook_url": "https://...",
                "webhook_payload": {
                    "type": "api",
                    "uuid": "9d1d8b9b-94fa-48d5-8578-73cbccee77ee",
                    "event": "PayoutCompleted",
                    "amount": 291,
                    "status": "PAYOUT_COMPLETE",
                    "currency": "USD",
                    "created_at": "2024-09-28 05:43:38",
                    "payee_uuid": "9d1d88a1-6158-47ef-bb2d-de194b812602",
                    "payer_uuid": "9d1d8b85-c384-4c8b-b2a8-63770db28a51",
                    "updated_at": "2024-10-01 07:30:25",
                    "payout_status": "PAYOUT_COMPLETE",
                    "capture_status": "CAPTURE_COMPLETE",
                    "clawback_status": null,
                    "transaction_fee": 0,
                    "payout_delay_days": 2,
                    "client_reference_id": "payout_44547"
                },
                "webhook_response": {
                    "status": true,
                    "status_code": 200
                },
                "date": "2024-10-01 08:00:41"
            }
        ],
        "pagination": {
            "total_items": 116,
            "per_page": 10,
            "current_page": 1,
            "total_pages": 12
        }
    },
    "errors": null,
    "error_code": null
}