Webhook Subscriptions

Update a webhook subscription

Toggle status (active/paused), update URL/events/description.

patch/webhook_subscriptions/{id}

Request

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

Path parameters

idstring required

Public Kirimdev webhook-subscription ID.

Example:wbs_01HXYZABCDEFGHJKMNPQRSTVWX

Request body

urlstring uri
descriptionstring nullable
eventsstring[]
status'active' | 'paused'
phone_number_idsstring[] nullable

Response

Updated subscription

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.