Skip to main content
GET
/
webhooks
/
events
List Events
curl --request GET \
  --url https://api.usepooler.com/webhooks/events \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "<string>",
  "stan": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data": {
    "total_pages": 123,
    "current_page": 123,
    "total_records": 123,
    "next_page": "<string>",
    "previous_page": "<string>",
    "items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "<string>",
        "event": "<string>",
        "data": {},
        "attempts": 123,
        "acknowledged": true,
        "acknowledged_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
}
Retrieve a paginated list of webhook events that have been generated for your account. This allows you to view the history of webhook events and their delivery status.

Overview

This endpoint returns all webhook events that have been generated for your account, including their status, delivery attempts, and acknowledgment status.

Query Parameters

page
integer
Page number for pagination
per_page
integer
Number of items per page

Response

data
object
Paginated response containing:
  • total_pages: Total number of pages
  • current_page: Current page number
  • total_records: Total number of webhook events
  • next_page: URL for next page
  • previous_page: URL for previous page
  • items: Array of webhook event objects
data.items[]
object
Each webhook event object includes:
  • id: Event UUID
  • type: Event type (e.g., “chargeback”)
  • event: Event name (e.g., “transfer.fulfilled”)
  • data: Event payload data
  • attempts: Number of delivery attempts
  • acknowledged: Whether event was acknowledged
  • acknowledged_at: Timestamp when acknowledged
  • created_at: Creation timestamp
  • updated_at: Last update timestamp

Authorizations

Authorization
string
header
required

Bearer token authentication. Include your API key in the Authorization header as: Bearer {your_api_key}

Query Parameters

page
integer

Page number for pagination

per_page
integer

Number of items per page

Response

200 - application/json

Webhook events retrieved successfully

success
boolean
message
string
stan
string<uuid>
data
object