WhatsApp Business icon

WhatsApp Business

WhatsApp Cloud API — send and receive business messages, media, and template events on a WhatsApp Business Account.

1 trigger31 searches47 actionsInstant (webhooks)Auth: OAuthAuth: API key

AI-assisted documentation15 min read

This documentation is compiled from our integration source code, internal specs for WhatsApp Business, its official API documentation and anonymized requests logs we collect from our support team[2].

Open WhatsApp Business on WEXTL →

Connecting WhatsApp Business takes an active account plus OAuth client credentials, granted by signing in with your account — no other setup is required.[3]

Credential type option 1

WhatsApp Business

You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.

  • App IDtextRequired

    Meta App ID (App Dashboard → Settings → Basic).

    [1]
  • App SecretpasswordRequired

    Meta App Secret. Also the HMAC key for X-Hub-Signature-256 if this app's webhook uses it.

    [1]
  • Account IDtextRequired

    Account ID (API Setup / WhatsApp Manager).

    [1]
  • Phone Number IDtextRequired

    Business phone number ID (not the display number). Used on /messages, /media, profile, and verify.

    [1]
Integration requests 3 permissions:
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.
Credential type option 2

WhatsApp Business - Access Token

  • Access TokenpasswordRequired

    Business settings → System Users → Generate token. Scopes whatsapp_business_management, whatsapp_business_messaging, business_management. Treat as opaque; do not parse.

    [1]
  • Account IDtextRequired

    Account ID (API Setup / WhatsApp Manager).

    [1]
  • Phone Number IDtextRequired

    Business phone number ID (not the display number). Used on /messages, /media, profile, and verify.

    [1]
  1. Log in to your WEXTL account, add the WhatsApp Business node module to your workflow, and click Create new credential.
    Instant triggers use webhooks — click Create a webhook first when adding one, then create the credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your WhatsApp Business account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Watch WhatsApp EventsTrigger
Output fields[3]
FieldType
Objecttext
Entryarray
Check Call PermissionsSearch
Input fields[3]
FieldType
User WA IDRequired
text
Output fields[3]
FieldType
Messaging Producttext
Permissionobject
Statustext
Download MediaSearch
Input fields[3]
FieldType
Media URLRequired
url
Output fields[3]
FieldType
Filetext
Filenametext
Content Typetext
Sizenumber
Get Business Compliance InfoSearch
Input fields[3]
FieldType
Fieldstext
Output fields[3]
FieldType
Dataarray
Get Business ProfileSearch
Input fields[3]
FieldType
Fieldstext
Output fields[3]
FieldType
Dataarray
Get Commerce SettingsSearch
Output fields[3]
FieldType
Dataarray
Get Encryption Public KeySearch
Input fields[3]
FieldType
Fieldstext
Output fields[3]
FieldType
Dataarray
Get FlowSearch
Input fields[3]
FieldType
FlowRequired
choice
Fieldstext
Date Formattext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Categoriesarray
Get GroupSearch
Input fields[3]
FieldType
GroupRequired
choice
Fieldstext
Output fields[3]
FieldType
IDtext
Subjecttext
Descriptiontext
Join Approval Modetext
Get MediaSearch
Input fields[3]
FieldType
Media IDRequired
text
Phone Numberchoice
Output fields[3]
FieldType
URLurl
MIME Typetext
SHA-256text
File Sizenumber
IDtext
Messaging Producttext
Get Message HistorySearch
Input fields[3]
FieldType
LimitRequired
number
Message IDtext
Fieldstext
Output fields[3]
FieldType
IDtext
Message IDtext
Get Message History EventsSearch
Input fields[3]
FieldType
Message HistoryRequired
choice
LimitRequired
number
Status Filterchoice
Fieldstext
Output fields[3]
FieldType
Cursortext
Nodeobject
IDtext
Delivery Statustext
Occurrence Timestampnumber
Get Official Business AccountSearch
Input fields[3]
FieldType
Fieldstext
Output fields[3]
FieldType
IDtext
OBA Statustext
Status Messagetext
Get Phone NumberSearch
Input fields[3]
FieldType
Fieldstext
Output fields[3]
FieldType
IDtext
Display Phone Numbertext
Verified Nametext
Quality Ratingtext
Get Phone Number SettingsSearch
Input fields[3]
FieldType
Include SIP Credentialsboolean
Output fields[3]
FieldType
Callingobject
Statustext
Call Icon Visibilitytext
Ip Addressesobject
Callback Permission Statustext
Videoobject
Payload Encryptionobject
Statustext
Storage Configurationobject
Statustext
Get QR CodeSearch
Input fields[3]
FieldType
QR CodeRequired
choice
Fieldstext
Output fields[3]
FieldType
Dataarray
Get TemplateSearch
Input fields[3]
FieldType
TemplateRequired
choice
Output fields[3]
FieldType
Nametext
Languagetext
Statustext
Categorytext
IDtext
Get WhatsApp Business AccountSearch
Input fields[3]
FieldType
Fieldstext
Output fields[3]
FieldType
IDtext
Nametext
Timezone IDtext
Account Review Statustext
Get WhatsApp Business BotSearch
Input fields[3]
FieldType
WhatsApp Business Bot IDRequired
text
Fieldstext
Output fields[3]
FieldType
IDtext
Enable Welcome Messageboolean
Promptsarray
Get WhatsApp Business ProfileSearch
Input fields[3]
FieldType
WhatsApp Business Profile IDRequired
text
Fieldstext
Output fields[3]
FieldType
IDtext
Account Nametext
Descriptiontext
Emailtext
Abouttext
Addresstext
Verticaltext
Websitesarray
Profile Picture Urlurl
Messaging Producttext
List Account ActivitiesSearch
Input fields[3]
FieldType
LimitRequired
number
Fieldstext
Sincetext
Untiltext
Activity Typetext
Output fields[3]
FieldType
IDtext
Activity Typetext
Timestamptext
Actor Nametext
Descriptiontext
List Assigned UsersSearch
Input fields[3]
FieldType
Business IDRequired
text
LimitRequired
number
Fieldstext
Output fields[3]
FieldType
IDtext
Nametext
User Typetext
List Blocked UsersSearch
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Messaging Producttext
WhatsApp IDtext
List Flow AssetsSearch
Input fields[3]
FieldType
FlowRequired
choice
LimitRequired
number
Output fields[3]
FieldType
Asset Typetext
Nametext
Download Urlurl
List FlowsSearch
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Categoriesarray
List GroupsSearch
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Subjecttext
Created Attext
List Join RequestsSearch
Input fields[3]
FieldType
GroupRequired
choice
LimitRequired
number
Output fields[3]
FieldType
Join Request IDtext
WA IDtext
Creation Timestampnumber
List Phone NumbersSearch
Input fields[3]
FieldType
LimitRequired
number
Fieldstext
Filteringtext
Sortchoice
Output fields[3]
FieldType
IDtext
Display Phone Numbertext
Verified Nametext
Statustext
Quality Ratingtext
List QR CodesSearch
Input fields[3]
FieldType
LimitRequired
number
Fieldstext
Codetext
Output fields[3]
FieldType
Codetext
Prefilled Messagetext
Deep Link Urlurl
List SchedulesSearch
Input fields[3]
FieldType
LimitRequired
number
Fieldstext
Filteringtext
Sortchoice
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Schedule Typetext
List TemplatesSearch
Input fields[3]
FieldType
LimitRequired
number
Nametext
Output fields[3]
FieldType
Nametext
Languagetext
Statustext
Categorytext
IDtext
List Webhook SubscriptionsSearch
Input fields[3]
FieldType
LimitRequired
number
Fieldstext
Output fields[3]
FieldType
Whatsapp Business Api Dataobject
IDtext
Nametext
Linkurl
Add Assigned UserAction
Input fields[3]
FieldType
UserRequired
text
TasksRequired
choice
Output fields[3]
FieldType
Successboolean
Add Group ParticipantsAction
Input fields[3]
FieldType
GroupRequired
choice
ParticipantsRequired
array
Output fields[3]
FieldType
Successboolean
Approve Join RequestsAction
Input fields[3]
FieldType
GroupRequired
choice
Join RequestsRequired
choice
Output fields[3]
FieldType
Messaging Producttext
Approved Join Requestsarray
Block UsersAction
Input fields[3]
FieldType
Block UsersRequired
array
Output fields[3]
FieldType
Block Usersobject
Added Usersarray
Messaging Producttext
Configure Conversational AutomationAction
Input fields[3]
FieldType
Enable Welcome Messageboolean
Promptsarray
Commandsarray
Output fields[3]
FieldType
Successboolean
Create FlowAction
Input fields[3]
FieldType
NameRequired
text
CategoriesRequired
choice
Clone Flowchoice
Endpoint URIurl
Output fields[3]
FieldType
IDtext
Create GroupAction
Input fields[3]
FieldType
SubjectRequired
text
Descriptiontext
Join Approval Modechoice
Output fields[3]
FieldType
Messaging Producttext
Request IDtext
Create Group Invite LinkAction
Create Phone NumberAction
Input fields[3]
FieldType
Phone NumberRequired
text
Verified NameRequired
text
Country Codetext
Migrate Phone Numberboolean
Pre-verified IDtext
Output fields[3]
FieldType
IDtext
Create QR CodeAction
Input fields[3]
FieldType
Prefilled MessageRequired
text
Codechoice
Generate QR Imagechoice
Output fields[3]
FieldType
Codetext
Prefilled Messagetext
Deep Link Urlurl
Qr Image Urlurl
Create ScheduleAction
Input fields[3]
FieldType
NameRequired
text
Schedule TypeRequired
choice
Start TimeRequired
text
End TimeRequired
text
Descriptiontext
Timezonetext
Days Of Weekchoice
Is Activeboolean
Recurrence Patternobject
Frequencychoice
Intervalnumber
End Datedate
Output fields[3]
FieldType
IDtext
Create TemplateAction
Input fields[3]
FieldType
NameRequired
text
LanguageRequired
text
CategoryRequired
choice
ComponentsRequired
text
Allow Category Changeboolean
Parameter Formatchoice
Output fields[3]
FieldType
IDtext
Statustext
Categorytext
Delete FlowAction
Input fields[3]
FieldType
FlowRequired
choice
Output fields[3]
FieldType
Successboolean
Delete GroupAction
Input fields[3]
FieldType
GroupRequired
choice
Output fields[3]
FieldType
Successboolean
Delete Group Invite LinkAction
Delete MediaAction
Input fields[3]
FieldType
Media IDRequired
text
Output fields[3]
FieldType
Successboolean
Delete QR CodeAction
Input fields[3]
FieldType
QR CodeRequired
choice
Output fields[3]
FieldType
Successboolean
Delete TemplateAction
Input fields[3]
FieldType
NameRequired
text
HSM IDtext
Output fields[3]
FieldType
Successboolean
Deprecate FlowAction
Input fields[3]
FieldType
FlowRequired
choice
Output fields[3]
FieldType
Successboolean
Deregister Phone NumberAction
Output fields[3]
FieldType
Successboolean
Edit TemplateAction
Input fields[3]
FieldType
TemplateRequired
choice
Componentstext
Categorychoice
Output fields[3]
FieldType
Successboolean
Make an API Calluniversal
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber
Manage CallAction
Input fields[3]
FieldType
ActionRequired
choice
Totext
Call IDtext
Sessionobject
SDP TypeRequired
choice
SDPRequired
text
Biz Opaque Callback Datatext
Output fields[3]
FieldType
Messaging Producttext
Callsarray
Migrate FlowsAction
Input fields[3]
FieldType
Source WABA IDRequired
text
Source Flow Namesarray
Output fields[3]
FieldType
Migrated Flowsarray
Publish FlowAction
Input fields[3]
FieldType
FlowRequired
choice
Output fields[3]
FieldType
Successboolean
Register Phone NumberAction
Input fields[3]
FieldType
PINRequired
text
Backupobject
Passwordtext
Datatext
Data Localization Regionchoice
Output fields[3]
FieldType
Successboolean
Reject Join RequestsAction
Input fields[3]
FieldType
GroupRequired
choice
Join RequestsRequired
choice
Output fields[3]
FieldType
Messaging Producttext
Rejected Join Requestsarray
Remove Assigned UserAction
Input fields[3]
FieldType
Business IDRequired
text
UserRequired
choice
Output fields[3]
FieldType
Successboolean
Remove Group ParticipantsAction
Input fields[3]
FieldType
GroupRequired
choice
ParticipantsRequired
array
Output fields[3]
FieldType
Successboolean
Request Verification CodeAction
Input fields[3]
FieldType
Code MethodRequired
choice
LanguageRequired
text
Output fields[3]
FieldType
Successboolean
Send Encrypted MessageAction
Input fields[3]
FieldType
PayloadRequired
text
Output fields[3]
FieldType
Messaging Producttext
Contactsarray
Messagesarray
Send MessageAction
Input fields[3]
FieldType
ToRequired
text
TypeRequired
choice
Recipient Typechoice
Textobject
BodyRequired
text
Preview URLboolean
Imageobject
Media IDtext
Linkurl
Captiontext
Videoobject
Media IDtext
Linkurl
Captiontext
Audioobject
Media IDtext
Linkurl
Documentobject
Media IDtext
Linkurl
Captiontext
Filenametext
Stickerobject
Media IDtext
Linkurl
Templateobject
NameRequired
text
LanguageRequired
object
Componentstext
Interactivetext
Locationobject
LatitudeRequired
text
LongitudeRequired
text
Nametext
Addresstext
Contactstext
Reactionobject
Message IDRequired
text
EmojiRequired
text
Contextobject
Message IDRequired
text
4other input fields
Output fields[3]
FieldType
Messaging Producttext
Contactsarray
Messagesarray
Set Commerce SettingsAction
Input fields[3]
FieldType
Cart Enabledboolean
Catalog Visibleboolean
Output fields[3]
FieldType
Successboolean
Set Encryption Public KeyAction
Input fields[3]
FieldType
Business Public KeyRequired
text
Output fields[3]
FieldType
Successboolean
Unblock UsersAction
Input fields[3]
FieldType
Block UsersRequired
array
Output fields[3]
FieldType
Block Usersobject
Removed Usersarray
Messaging Producttext
Update Business Compliance InfoAction
Input fields[3]
FieldType
Entity NameRequired
text
Entity TypeRequired
choice
Grievance Officer DetailsRequired
object
NameRequired
text
EmailRequired
email
Mobile Numbertext
Landline Numbertext
Customer Care DetailsRequired
object
EmailRequired
email
Mobile Numbertext
Landline Numbertext
Entity Type Customtext
Is Registeredboolean
Output fields[3]
FieldType
Successboolean
Update Business ProfileAction
Input fields[3]
FieldType
Abouttext
Verticalchoice
Websitesarray
Addresstext
Descriptiontext
Emailemail
Profile Picture Handletext
Output fields[3]
FieldType
Successboolean
Update Flow JSONAction
Input fields[3]
FieldType
FlowRequired
choice
FileRequired
text
NameRequired
text
Asset Typetext
File Nametext
Output fields[3]
FieldType
Successboolean
Validation Errorsarray
Update Flow MetadataAction
Input fields[3]
FieldType
FlowRequired
choice
Nametext
Categorieschoice
Endpoint URIurl
Output fields[3]
FieldType
Successboolean
Update Group SettingsAction
Input fields[3]
FieldType
GroupRequired
choice
Subjecttext
Descriptiontext
Output fields[3]
FieldType
Successboolean
Update Official Business AccountAction
Input fields[3]
FieldType
Business Website URLRequired
url
Primary Country of OperationRequired
text
Primary Languagetext
Parent Business or Brandtext
Supporting Linksarray
Additional Supporting Informationtext
Output fields[3]
FieldType
Successboolean
Messagetext
Updated Statusobject
IDtext
OBA Statustext
Status Messagetext
Tracking Idtext
Update Phone NumberAction
Input fields[3]
FieldType
Connection Statuschoice
Webhook URLurl
PINtext
Search Visibilitychoice
New Display Nametext
Usernametext
WhatsApp Business API Dataobject
PINtext
Show Security Notificationsboolean
Notify User Change Numberboolean
Webhook Configurationobject
Override Callback URIRequired
url
Verify Tokentext
Output fields[3]
FieldType
Successboolean
Update Phone Number SettingsAction
Input fields[3]
FieldType
Callingobject
Statuschoice
Call Icon Visibilitychoice
Videoobject
SIPobject
User Identity Changeobject
Enabledboolean
Payload Encryptionobject
Statuschoice
Client Encryption Keytext
Storage Configurationobject
Enabledboolean
Regiontext
Output fields[3]
FieldType
Successboolean
Update WhatsApp Business AccountAction
Input fields[3]
FieldType
Nametext
Timezone IDtext
Output fields[3]
FieldType
Successboolean
Update WhatsApp Business ProfileAction
Input fields[3]
FieldType
WhatsApp Business Profile IDRequired
text
Abouttext
Verticalchoice
Websitesarray
Addresstext
Descriptiontext
Emailemail
Profile Picture Handletext
Output fields[3]
FieldType
Successboolean
Upload MediaAction
Input fields[3]
FieldType
FileRequired
text
MIME TypeRequired
text
File Nametext
Output fields[3]
FieldType
IDtext
Verify Phone Number CodeAction
Input fields[3]
FieldType
CodeRequired
text
Output fields[3]
FieldType
Successboolean
IDtext

Look for WhatsApp Business templates in the WEXTL template library.

Browse templates →
  1. WEXTL® WhatsApp Business Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for WhatsApp Business.
  4. WEXTL® visual workflow builder data.

Last updated: Aug 21, 2026 02:27