Skip to content
Kirim Docs
Webhook Subscriptions

List webhook subscriptions

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

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
status
string
Allowed values: active paused disabled all
limit
string
/^\d+$/
cursor
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Subscription list

Media type application/json
object
data
required
Array<object>
object
id
required
string
object
required
string
Allowed values: webhook_subscription
url
required
string format: uri
description
required
string | null
events
required
Array<string>
status
required
string
Allowed values: active paused disabled
disabled_reason
required
string | null
consecutive_failures
required
integer
secrets
required
Array<object>
object
id
required
string
created_at
required
string format: date-time
expires_at
required
string | null format: date-time
created_at
required
string format: date-time
updated_at
required
string format: date-time
initial_secret
string
has_more
required
boolean
next_cursor
required
string | null
request_id
required
string
Example 
{
  "data": [
    {
      "id": "wbs_01HXYZABCDEFGHJKMNPQRSTVWX",
      "object": "webhook_subscription",
      "status": "active",
      "secrets": [
        {
          "id": "sec_01HXYZABCDEFGHJKMNPQRSTVWX"
        }
      ]
    }
  ]
}

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