Webhook Subscriptions

List webhook subscriptions

List webhook subscriptions in this organization, newest first. Omit status to return all states, or filter to one lifecycle state; paginate with the opaque cursor returned by the previous page.

get/webhook_subscriptions

Request

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

Query parameters

status'active' | 'paused' | 'disabled' | 'all'

Filter by subscription lifecycle state. Omit to return all states.

Example:active
limitstring

Number of items to return. Defaults to 25; minimum 1 and maximum 100.

Example:25
cursorstring

Opaque continuation token from the previous response's next_cursor. Pass it unchanged and keep all other filters the same.

Example:eyJpZCI6IjAxSFhZWkFCQ0RFRkdISktNTlBRUlNUVldYIiwidHMiOiIyMDI2LTA5LTEwVDA5OjAwOjAwLjAwMFoifQ

Response

Subscription list

has_moreboolean required

Whether another page is available.

next_cursorstring nullable required

Pass this value unchanged as cursor to fetch the next page. null marks the final page.

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.