WhatsApp Cloud API
This is a shipped runtime-backed surface: direct sends are implemented, the serve loop is implemented, and the channel can joingateway run or gateway run.
At A Glance
| Field | Value |
|---|---|
| Catalog id | whatsapp |
| Config key | whatsapp |
| Implementation status | runtime_backed |
| Transport | whatsapp_cloud_api |
| Aliases | wa, whatsapp-cloud |
| Default send target kind | address |
Minimal Config
Smoke Test
Command Surface
| Operation | Command | Usage or status |
|---|---|---|
| business send | channels send whatsapp | Usage: loong channels send whatsapp [OPTIONS] —target <TARGET> —text <TEXT> |
| cloud webhook service | channels serve whatsapp | Usage: loong channels serve whatsapp [OPTIONS] |
Required Fields For Send
| Requirement | Config paths | Env pointer paths | Default env |
|---|---|---|---|
| channel enabled | whatsapp.enabledwhatsapp.accounts.<account>.enabled | none | none |
| cloud api access token | whatsapp.access_tokenwhatsapp.accounts.<account>.access_token | whatsapp.access_token_envwhatsapp.accounts.<account>.access_token_env | WHATSAPP_ACCESS_TOKEN |
| phone number id | whatsapp.phone_number_idwhatsapp.accounts.<account>.phone_number_id | whatsapp.phone_number_id_envwhatsapp.accounts.<account>.phone_number_id_env | WHATSAPP_PHONE_NUMBER_ID |
Required Fields For Serve
| Requirement | Config paths | Env pointer paths | Default env |
|---|---|---|---|
| channel enabled | whatsapp.enabledwhatsapp.accounts.<account>.enabled | none | none |
| cloud api access token | whatsapp.access_tokenwhatsapp.accounts.<account>.access_token | whatsapp.access_token_envwhatsapp.accounts.<account>.access_token_env | WHATSAPP_ACCESS_TOKEN |
| phone number id | whatsapp.phone_number_idwhatsapp.accounts.<account>.phone_number_id | whatsapp.phone_number_id_envwhatsapp.accounts.<account>.phone_number_id_env | WHATSAPP_PHONE_NUMBER_ID |
| webhook verify token | whatsapp.verify_tokenwhatsapp.accounts.<account>.verify_token | whatsapp.verify_token_envwhatsapp.accounts.<account>.verify_token_env | WHATSAPP_VERIFY_TOKEN |
| meta app secret | whatsapp.app_secretwhatsapp.accounts.<account>.app_secret | whatsapp.app_secret_envwhatsapp.accounts.<account>.app_secret_env | WHATSAPP_APP_SECRET |
Gateway And Ownership
This surface can run directly throughchannels serve whatsapp, or under Gateway And Supervision through gateway run.
Operator Notes
- This page documents the current WhatsApp Cloud API business-account lane: outbound sends are shipped and the webhook reply service is also implemented.
- Serve mode needs
verify_tokenandapp_secretin addition to the Cloud API access token and phone number id. - Keep the Cloud API credential path distinct from the QR-linked WhatsApp Personal surface so operators do not confuse Meta business credentials with personal-account pairing.
Related Docs
- Continue to WhatsApp Personal for the QR-linked personal-account bridge lane.
- Continue to Channel Guides for the full shipped channel matrix.
- Continue to Channels for the conceptual surface model.
- Continue to Channel Setup for the shared public setup contract.
- Continue to Gateway And Supervision when this surface needs longer-lived runtime ownership.