Skip to content
Webhook Deliveries

Fetch one delivery (with full payload)

GET
/webhook_deliveries/{id}
curl --request GET \
--url https://api-kckit.kirim.chat/v1/webhook_deliveries/example \
--header 'Authorization: Bearer <token>'
id
required
string
/^wbd_[0-9A-HJKMNP-TV-Z]{26}$/

Delivery resource

Media type application/json
object
data
required
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
request_id
required
string
Example
{
"data": {
"id": "wbd_01HXYZABCDEFGHJKMNPQRSTVWX",
"object": "webhook_delivery",
"status": "pending"
}
}

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"
}
}

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"
}
}

Resource not found

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"
}
}

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"
}
}

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"
}
}