Skip to main content
GET
/
webhook_deliveries
List webhook deliveries
curl --request GET \
  --url https://api.kapso.ai/platform/v1/webhook_deliveries \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "event": "<string>",
      "status": "pending",
      "attempt_count": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "response_status": 123,
      "delivered_at": "2023-11-07T05:31:56Z",
      "failed_at": "2023-11-07T05:31:56Z",
      "last_attempt_at": "2023-11-07T05:31:56Z",
      "webhook_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "webhook_url": "<string>",
      "whatsapp_config_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "phone_number_id": "<string>",
      "conversation_phone_number": "<string>"
    }
  ],
  "meta": {
    "page": 2,
    "per_page": 2,
    "total_pages": 1,
    "total_count": 1
  }
}

Authorizations

X-API-Key
string
header
required

Query Parameters

status
enum<string>

Filter by delivery status

Available options:
pending,
delivered,
failed
event
string

Filter by event type

webhook_id
string<uuid>

Filter by webhook ID

errors_only
boolean
default:false

Only return failed deliveries

period
enum<string>
default:24h

Time period filter

Available options:
24h,
7d,
30d
page
integer
default:1
Required range: x >= 1
per_page
integer
default:20
Required range: x >= 1

Response

Success

data
object[]
required
meta
object
required