Webhook Subscriptions

Create a webhook subscription

Create a webhook subscription. Store initial_secret server-side immediately. It is returned in the initial response and replayed for 24 hours when the same POST is retried with the same Idempotency-Key; outside that replay, Kirimdev cannot show it again.

post/webhook_subscriptions

Request

  • Base URL: https://api.kirimdev.com/v1
  • URL: https://api.kirimdev.com/v1/webhook_subscriptions
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Optional retry key. Reusing the same key with the same method, path, and body within 24 hours returns the original response; reusing it for a different request returns 422.

Example:order-20260910-0001

Request body

urlstring uri required
descriptionstring
eventsstring[] required
phone_number_idsstring[]

Response

Created

request_idstring required

Unique request identifier to include when contacting support.

Example response

{
  "data": {
    "id": "wbs_01HXYZABCDEFGHJKMNPQRSTVWX",
    "phone_number_ids": [
      "1234567890"
    ],
    "secrets": [
      {
        "id": "sec_01HXYZABCDEFGHJKMNPQRSTVWX"
      }
    ]
  },
  "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
}

Changes

No recorded changes to this operation across all 1 revision of this API.