v1

latestOpenAPI 3.0.0Proprietary2026-08-062711471.0 MB

Incoming Webhooks

List incoming webhook events

Lists received events (deliveries) for an incoming webhook. Filter by date range, status, and search. Requires a USER API key.

get/public/v1/incoming-webhooks/{webhookId}/events

Path parameters

webhookIdstring required

Example:clx123incomingwebhook

Query parameters

startDatestring nullable

Example:example

endDatestring nullable

Example:example

searchstring

Example:example

status'RECEIVED' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'TIMEOUT'

Example:RECEIVED

Response

Paginated incoming webhook events

countnumber

pageSizenumber required

pageNumnumber

totalPagesnumber

cursornumber

paginationType'offset' | 'cursor'

Example response

{
  "count": 1,
  "pageSize": 1,
  "pageNum": 1,
  "totalPages": 1,
  "cursor": 1,
  "results": [
    {
      "id": "clx987event",
      "status": "COMPLETED",
      "payloadSize": 512,
      "ipAddress": "203.0.113.10",
      "userAgent": "curl/8.4.0",
      "createdAt": "2024-01-01T12:00:00Z",
      "updatedAt": "2024-01-01T12:00:00Z"
    }
  ],
  "paginationType": "offset",
  "nextCursor": "example"
}