Webhook Subscriptions

Create a webhook subscription

POST

/webhook_subscriptions

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://api.kirim.chat/v1/webhook_subscriptions"

  payload := strings.NewReader("{ \"url\": \"https://example.com\", \"description\": \"example\", \"events\": [ \"message.received\" ] }")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Authorization", "Bearer <token>")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://api.kirim.chat/v1/webhook_subscriptions';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"url":"https://example.com","description":"example","events":["message.received"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

use serde_json::json;
use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "https://api.kirim.chat/v1/webhook_subscriptions";

    let payload = json!({
        "url": "https://example.com",
        "description": "example",
        "events": ("message.received")
    });

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("Authorization", "Bearer <token>".parse().unwrap());
    headers.insert("Content-Type", "application/json".parse().unwrap());

    let client = reqwest::Client::new();
    let response = client.post(url)
        .headers(headers)
        .json(&payload)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

curl --request POST \
  --url https://api.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

bearerAuth

Request Body

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

200

Created

application/json

object

data

required

object

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

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

Validation failure

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

Authentication failure

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

Rate limit exceeded

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

Internal server error

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

Service unavailable

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