About this integration
WhatsApp Cloud API — send and receive business messages, media, and template events on a WhatsApp Business Account. Connect it to any workflow without writing code.
You can choose from 1 trigger, 31 search modules and 47 actions. The connection type is oauth or basic authentication. Webhook-based triggers fire instantly without polling.
How to connect
The credential form asks for App ID, App Secret, Account ID, and Phone Number ID.
OAuth asks you to approve Manage WhatsApp Business Account assets, phone numbers, and templates., Send and receive WhatsApp Cloud API messages., and Read and manage Business Manager assets used by WhatsApp Cloud API. before access is granted.
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
| Field | Type | Help |
|---|---|---|
App IDRequired | text | Meta App ID (App Dashboard → Settings → Basic). |
App SecretRequired | password | Meta App Secret. Also the HMAC key for X-Hub-Signature-256 if this app's webhook uses it. |
Account IDRequired | text | Account ID (API Setup / WhatsApp Manager). |
Phone Number IDRequired | text | Business phone number ID (not the display number). Used on /messages, /media, profile, and verify. |
Permissions requested
- Manage WhatsApp Business Account assets, phone numbers, and templates.
- Send and receive WhatsApp Cloud API messages.
- Read and manage Business Manager assets used by WhatsApp Cloud API.
Enter your credentials below. WEXTL stores them encrypted and uses them only to call the API on your behalf.
| Field | Type | Help |
|---|---|---|
Access TokenRequired | password | Business settings → System Users → Generate token. Scopes whatsapp_business_management, whatsapp_business_messaging, business_management. Treat as opaque; do not parse. |
Account IDRequired | text | Account ID (API Setup / WhatsApp Manager). |
Phone Number IDRequired | text | Business phone number ID (not the display number). Used on /messages, /media, profile, and verify. |
Use it in workflow automation
Start with Watch WhatsApp Events, then add Add Assigned User.
Triggers, searches and actions
Explore the fields available for each WhatsApp Business trigger, search, and action — 1 trigger, 31 searchs, and 47 actions.
Triggers
Whenever something changes in the app, one of 1 available trigger can start a run immediately.
- Watch WhatsApp Events
Searches
31 search modules let you query the app mid-run and feed the results to the next step.
- Check Call Permissions
- Download Media
- Get Business Compliance Info
- Get Business Profile
- Get Commerce Settings
26more searches
Actions
Use 47 action modules to write data back into the app from anywhere in a run.
- Add Assigned User
- Add Group Participants
- Approve Join Requests
- Block Users
- Configure Conversational Automation
42more actions
Explore the fields available for each WhatsApp Business trigger, search, and action.
Triggers
Output fields
| Field | Type |
|---|---|
Object | text |
Entry | array |
Searches
Input fields
| Field | Type |
|---|---|
User WA IDRequired | text |
Output fields
| Field | Type |
|---|---|
Messaging Product | text |
Permission | object |
Status | text |
Input fields
| Field | Type |
|---|---|
Media URLRequired | url |
Output fields
| Field | Type |
|---|---|
File | text |
Filename | text |
Content Type | text |
Size | number |
Input fields
| Field | Type |
|---|---|
Fields | text |
Output fields
| Field | Type |
|---|---|
Data | array |
Input fields
| Field | Type |
|---|---|
Fields | text |
Output fields
| Field | Type |
|---|---|
Data | array |
Output fields
| Field | Type |
|---|---|
Data | array |
Input fields
| Field | Type |
|---|---|
Fields | text |
Output fields
| Field | Type |
|---|---|
Data | array |
Input fields
| Field | Type |
|---|---|
FlowRequired | choice |
Fields | text |
Date Format | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Status | text |
Categories | array |
Input fields
| Field | Type |
|---|---|
GroupRequired | choice |
Fields | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Subject | text |
Description | text |
Join Approval Mode | text |
Input fields
| Field | Type |
|---|---|
Media IDRequired | text |
Phone Number | choice |
Output fields
| Field | Type |
|---|---|
URL | url |
MIME Type | text |
SHA-256 | text |
File Size | number |
ID | text |
Messaging Product | text |
Input fields
| Field | Type |
|---|---|
LimitRequired | number |
Message ID | text |
Fields | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Message ID | text |
Input fields
| Field | Type |
|---|---|
Message HistoryRequired | choice |
LimitRequired | number |
Status Filter | choice |
Fields | text |
Output fields
| Field | Type |
|---|---|
Cursor | text |
Node | object |
ID | text |
Delivery Status | text |
Occurrence Timestamp | number |
Input fields
| Field | Type |
|---|---|
Fields | text |
Output fields
| Field | Type |
|---|---|
ID | text |
OBA Status | text |
Status Message | text |
Input fields
| Field | Type |
|---|---|
Fields | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Display Phone Number | text |
Verified Name | text |
Quality Rating | text |
Input fields
| Field | Type |
|---|---|
Include SIP Credentials | boolean |
Output fields
| Field | Type |
|---|---|
Calling | object |
Status | text |
Call Icon Visibility | text |
Ip Addresses | object |
Callback Permission Status | text |
Video | object |
Payload Encryption | object |
Status | text |
Storage Configuration | object |
Status | text |
Input fields
| Field | Type |
|---|---|
QR CodeRequired | choice |
Fields | text |
Output fields
| Field | Type |
|---|---|
Data | array |
Input fields
| Field | Type |
|---|---|
TemplateRequired | choice |
Output fields
| Field | Type |
|---|---|
Name | text |
Language | text |
Status | text |
Category | text |
ID | text |
Input fields
| Field | Type |
|---|---|
Fields | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Timezone ID | text |
Account Review Status | text |
Input fields
| Field | Type |
|---|---|
WhatsApp Business Bot IDRequired | text |
Fields | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Enable Welcome Message | boolean |
Prompts | array |
Input fields
| Field | Type |
|---|---|
WhatsApp Business Profile IDRequired | text |
Fields | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Account Name | text |
Description | text |
Email | text |
About | text |
Address | text |
Vertical | text |
Websites | array |
Profile Picture Url | url |
Messaging Product | text |
Input fields
| Field | Type |
|---|---|
LimitRequired | number |
Fields | text |
Since | text |
Until | text |
Activity Type | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Activity Type | text |
Timestamp | text |
Actor Name | text |
Description | text |
Input fields
| Field | Type |
|---|---|
Business IDRequired | text |
LimitRequired | number |
Fields | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
User Type | text |
Input fields
| Field | Type |
|---|---|
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
Messaging Product | text |
WhatsApp ID | text |
Input fields
| Field | Type |
|---|---|
FlowRequired | choice |
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
Asset Type | text |
Name | text |
Download Url | url |
Input fields
| Field | Type |
|---|---|
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Status | text |
Categories | array |
Input fields
| Field | Type |
|---|---|
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Subject | text |
Created At | text |
Input fields
| Field | Type |
|---|---|
GroupRequired | choice |
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
Join Request ID | text |
WA ID | text |
Creation Timestamp | number |
Input fields
| Field | Type |
|---|---|
LimitRequired | number |
Fields | text |
Filtering | text |
Sort | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Display Phone Number | text |
Verified Name | text |
Status | text |
Quality Rating | text |
Input fields
| Field | Type |
|---|---|
LimitRequired | number |
Fields | text |
Code | text |
Output fields
| Field | Type |
|---|---|
Code | text |
Prefilled Message | text |
Deep Link Url | url |
Input fields
| Field | Type |
|---|---|
LimitRequired | number |
Fields | text |
Filtering | text |
Sort | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Status | text |
Schedule Type | text |
Input fields
| Field | Type |
|---|---|
LimitRequired | number |
Name | text |
Output fields
| Field | Type |
|---|---|
Name | text |
Language | text |
Status | text |
Category | text |
ID | text |
Input fields
| Field | Type |
|---|---|
LimitRequired | number |
Fields | text |
Output fields
| Field | Type |
|---|---|
Whatsapp Business Api Data | object |
ID | text |
Name | text |
Link | url |
Actions
Input fields
| Field | Type |
|---|---|
UserRequired | text |
TasksRequired | choice |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
GroupRequired | choice |
ParticipantsRequired | array |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
GroupRequired | choice |
Join RequestsRequired | choice |
Output fields
| Field | Type |
|---|---|
Messaging Product | text |
Approved Join Requests | array |
Input fields
| Field | Type |
|---|---|
Block UsersRequired | array |
Output fields
| Field | Type |
|---|---|
Block Users | object |
Added Users | array |
Messaging Product | text |
Input fields
| Field | Type |
|---|---|
Enable Welcome Message | boolean |
Prompts | array |
Commands | array |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
NameRequired | text |
CategoriesRequired | choice |
Clone Flow | choice |
Endpoint URI | url |
Output fields
| Field | Type |
|---|---|
ID | text |
Input fields
| Field | Type |
|---|---|
SubjectRequired | text |
Description | text |
Join Approval Mode | choice |
Output fields
| Field | Type |
|---|---|
Messaging Product | text |
Request ID | text |
Input fields
| Field | Type |
|---|---|
GroupRequired | choice |
Output fields
| Field | Type |
|---|---|
Messaging Product | text |
Invite Link | url |
Input fields
| Field | Type |
|---|---|
Phone NumberRequired | text |
Verified NameRequired | text |
Country Code | text |
Migrate Phone Number | boolean |
Pre-verified ID | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Input fields
| Field | Type |
|---|---|
Prefilled MessageRequired | text |
Code | choice |
Generate QR Image | choice |
Output fields
| Field | Type |
|---|---|
Code | text |
Prefilled Message | text |
Deep Link Url | url |
Qr Image Url | url |
Input fields
| Field | Type |
|---|---|
NameRequired | text |
Schedule TypeRequired | choice |
Start TimeRequired | text |
End TimeRequired | text |
Description | text |
Timezone | text |
Days Of Week | choice |
Is Active | boolean |
Recurrence Pattern | object |
Frequency | choice |
Interval | number |
End Date | date |
Output fields
| Field | Type |
|---|---|
ID | text |
Input fields
| Field | Type |
|---|---|
NameRequired | text |
LanguageRequired | text |
CategoryRequired | choice |
ComponentsRequired | text |
Allow Category Change | boolean |
Parameter Format | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Status | text |
Category | text |
Input fields
| Field | Type |
|---|---|
FlowRequired | choice |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
GroupRequired | choice |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
GroupRequired | choice |
Output fields
| Field | Type |
|---|---|
Messaging Product | text |
Success | text |
Input fields
| Field | Type |
|---|---|
Media IDRequired | text |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
QR CodeRequired | choice |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
NameRequired | text |
HSM ID | text |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
FlowRequired | choice |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
TemplateRequired | choice |
Components | text |
Category | choice |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
Headers | array |
Header | object |
Query String | array |
Parameter | object |
Body | text |
Output fields
| Field | Type |
|---|---|
Body | text |
Headers | object |
Status code | number |
Input fields
| Field | Type |
|---|---|
ActionRequired | choice |
To | text |
Call ID | text |
Session | object |
SDP TypeRequired | choice |
SDPRequired | text |
Biz Opaque Callback Data | text |
Output fields
| Field | Type |
|---|---|
Messaging Product | text |
Calls | array |
Input fields
| Field | Type |
|---|---|
Source WABA IDRequired | text |
Source Flow Names | array |
Output fields
| Field | Type |
|---|---|
Migrated Flows | array |
Input fields
| Field | Type |
|---|---|
FlowRequired | choice |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
PINRequired | text |
Backup | object |
Password | text |
Data | text |
Data Localization Region | choice |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
GroupRequired | choice |
Join RequestsRequired | choice |
Output fields
| Field | Type |
|---|---|
Messaging Product | text |
Rejected Join Requests | array |
Input fields
| Field | Type |
|---|---|
Business IDRequired | text |
UserRequired | choice |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
GroupRequired | choice |
ParticipantsRequired | array |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
Code MethodRequired | choice |
LanguageRequired | text |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
PayloadRequired | text |
Output fields
| Field | Type |
|---|---|
Messaging Product | text |
Contacts | array |
Messages | array |
Input fields
| Field | Type |
|---|---|
ToRequired | text |
TypeRequired | choice |
Recipient Type | choice |
Text | object |
BodyRequired | text |
Preview URL | boolean |
Image | object |
Media ID | text |
Link | url |
Caption | text |
Video | object |
Media ID | text |
Link | url |
Caption | text |
Audio | object |
Media ID | text |
Link | url |
Document | object |
Media ID | text |
Link | url |
Caption | text |
Filename | text |
Sticker | object |
Media ID | text |
Link | url |
Template | object |
NameRequired | text |
LanguageRequired | object |
Components | text |
Interactive | text |
Location | object |
LatitudeRequired | text |
LongitudeRequired | text |
Name | text |
Address | text |
Contacts | text |
Reaction | object |
Message IDRequired | text |
EmojiRequired | text |
Context | object |
Message IDRequired | text |
4other input fields
Output fields
| Field | Type |
|---|---|
Messaging Product | text |
Contacts | array |
Messages | array |
Input fields
| Field | Type |
|---|---|
Cart Enabled | boolean |
Catalog Visible | boolean |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
Business Public KeyRequired | text |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
Block UsersRequired | array |
Output fields
| Field | Type |
|---|---|
Block Users | object |
Removed Users | array |
Messaging Product | text |
Input fields
| Field | Type |
|---|---|
Entity NameRequired | text |
Entity TypeRequired | choice |
Grievance Officer DetailsRequired | object |
NameRequired | text |
EmailRequired | |
Mobile Number | text |
Landline Number | text |
Customer Care DetailsRequired | object |
EmailRequired | |
Mobile Number | text |
Landline Number | text |
Entity Type Custom | text |
Is Registered | boolean |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
About | text |
Vertical | choice |
Websites | array |
Address | text |
Description | text |
Email | |
Profile Picture Handle | text |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
FlowRequired | choice |
FileRequired | text |
NameRequired | text |
Asset Type | text |
File Name | text |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Validation Errors | array |
Input fields
| Field | Type |
|---|---|
FlowRequired | choice |
Name | text |
Categories | choice |
Endpoint URI | url |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
GroupRequired | choice |
Subject | text |
Description | text |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
Business Website URLRequired | url |
Primary Country of OperationRequired | text |
Primary Language | text |
Parent Business or Brand | text |
Supporting Links | array |
Additional Supporting Information | text |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Message | text |
Updated Status | object |
ID | text |
OBA Status | text |
Status Message | text |
Tracking Id | text |
Input fields
| Field | Type |
|---|---|
Connection Status | choice |
Webhook URL | url |
PIN | text |
Search Visibility | choice |
New Display Name | text |
Username | text |
WhatsApp Business API Data | object |
PIN | text |
Show Security Notifications | boolean |
Notify User Change Number | boolean |
Webhook Configuration | object |
Override Callback URIRequired | url |
Verify Token | text |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
Calling | object |
Status | choice |
Call Icon Visibility | choice |
Video | object |
SIP | object |
User Identity Change | object |
Enabled | boolean |
Payload Encryption | object |
Status | choice |
Client Encryption Key | text |
Storage Configuration | object |
Enabled | boolean |
Region | text |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
Name | text |
Timezone ID | text |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
WhatsApp Business Profile IDRequired | text |
About | text |
Vertical | choice |
Websites | array |
Address | text |
Description | text |
Email | |
Profile Picture Handle | text |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
FileRequired | text |
MIME TypeRequired | text |
File Name | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Input fields
| Field | Type |
|---|---|
CodeRequired | text |
Output fields
| Field | Type |
|---|---|
Success | boolean |
ID | text |