Skip to content
Kirim Docs
Webhook Subscriptions

Create a webhook subscription

POST
/webhook_subscriptions
 
curl --request POST \
  --url https://api-kckit.kirim.chat/v1/webhook_subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "url": "https://example.com", "description": "example", "events": [ "message.received" ] }'

Create a webhook subscription. The response carries initial_secret ONCE — store it server-side immediately; Kirim cannot show it again.

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”
Media type application/json
object
url
required
string format: uri
description
string
<= 200 characters
events
required
Array<string>
>= 1 items
Allowed values: message.received message.status conversation.assigned conversation.closed contact.created contact.updated

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Created

Media type application/json
object
data
required
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
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"
  }
}

503

Section titled “503 ”

Service unavailable

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