Skip to main content
A webhook campaign sends one WhatsApp template to one end user per API call. Each accepted send is charged against the campaign wallet.

​
Keys and access

A campaign key is an ordinary API key with Send campaign messages and access limited to the campaign. An All resources key also works. Admins create and manage keys in Settings → Integrations → API keys. The campaign’s API keys tab lists eligible keys. Selected keys that include the campaign lock its template, parameters and number. Revoke those keys or clone the campaign before changing them.

​
Validate and send

Validate checks the request and returns pricing without sending or charging. It does not check consent or wallet balance. Validate and send share the campaign-send rate limit. Both can return a retryable problem.

​
Pricing and lifecycle

A send is charged before delivery. A failed send is refunded. Staging-mode sends are not charged. A paused campaign returns retryable campaign_paused. A cancelled or failed campaign returns terminal campaign_gone. See Errors for the problem format and Run webhook campaigns for setup.