Skip to content
Kirim Docs
Webhook Deliveries

List webhook deliveries

GET
/webhook_deliveries
 
curl --request GET \
  --url 'https://api-kckit.kirim.chat/v1/webhook_deliveries?status=pending' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
subscription_id
string
/^wbs_[0-9A-HJKMNP-TV-Z]{26}$/
status
string
Allowed values: pending succeeded failed dead
event_type
string
>= 1 characters <= 64 characters
created_after
string format: date-time
created_before
string format: date-time
limit
string
/^\d+$/
cursor
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Delivery list

Media type application/json
object
data
required
Array<object>
object
id
required
string
object
required
string
Allowed values: webhook_delivery
subscription_id
required
string
event_type
required
string
event_id
required
string
status
required
string
Allowed values: pending succeeded failed dead
attempt_count
required
integer
last_attempt_at
required
string | null format: date-time
next_attempt_at
required
string | null format: date-time
response_status
required
integer | null
response_body_snippet
required
string | null
duration_ms
required
integer | null
replayed_from
required
string | null
payload
created_at
required
string format: date-time
has_more
required
boolean
next_cursor
required
string | null
request_id
required
string
Example 
{
  "data": [
    {
      "id": "wbd_01HXYZABCDEFGHJKMNPQRSTVWX",
      "object": "webhook_delivery",
      "status": "pending"
    }
  ]
}

400

Section titled “400 ”

Validation failure

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
request_id
required
string
Example 
{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

401

Section titled “401 ”

Authentication failure

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
request_id
required
string
Example 
{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

429

Section titled “429 ”

Rate limit exceeded

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
request_id
required
string
Example 
{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

500

Section titled “500 ”

Internal server error

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
request_id
required
string
Example 
{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}