Kirim icon

Kirim

Send WhatsApp messages and manage your inbox via the Kirimdev API

Webhook Subscription → List

AI-generated

Summary

List webhook subscriptions configured for a WhatsApp account, optionally filtered by status.

Inputs

  • statusFilter — Filter subscriptions by status: Active, Disabled, or Paused. 'All (Incl. Disabled)' returns all subscriptions regardless of status.
  • limit — Maximum number of subscriptions to return. Defaults to 50 and must be between 1 and 100.
  • cursor — Opaque pagination cursor to retrieve the next page of results.
  • requestOptions — Advanced HTTP request settings including batching, proxy configuration, timeout, and SSL validation options.

Output shape

a list of items, each representing a webhook subscription with details such as ID, URL, events, and secrets.

Supports pagination via cursor-based navigation. The node does not automatically fetch all pages; use the cursor to paginate manually.

Examples

Example 1: List all active subscriptions for the selected account

Set statusFilter to 'Active', limit to 20.

Example 2: Retrieve the first page of subscriptions including paused and disabled ones

Set statusFilter to 'All (Incl. Disabled)'.

Example 3: Iterate through all subscriptions using pagination

Use the 'cursor' field to fetch subsequent pages until no cursor is returned.

Links

Discussion