Kirim icon

Kirim

Send WhatsApp messages and manage your inbox via the Kirimdev API

Webhook Subscription → Update

AI-generated

Summary

Updates a webhook subscription by modifying its URL, description, events list, or status.

Inputs

  • subscriptionId (required) — The ID of the webhook subscription to update (e.g., wbs_…).
  • updateUrl — New HTTPS URL for the subscription. Leave blank to keep the current URL.
  • updateDescription — New description for the subscription. Leave blank to keep the current description.
  • updateEvents — List of event types to subscribe to. Use this to replace the current events list; leave empty to keep existing events.
  • updateStatus — Set to 'active' to resume deliveries, or 'paused' to temporarily stop deliveries without deleting the subscription.
  • requestOptions — Configuration for HTTP requests, including batching, proxy, timeout, and SSL verification.

Output shape

no body — success/failure only

Returns the updated subscription configuration or an error if the update fails.

Examples

Example 1: Change the webhook URL for an existing subscription

Set subscriptionId and updateUrl to the new endpoint.

Example 2: Pause a subscription to stop incoming deliveries temporarily

Set subscriptionId and updateStatus to 'paused'.

Example 3: Replace all event types for a subscription

Set subscriptionId and updateEvents to the new list of events.

Links

Discussion