DashboardSign inStart your trial

WhatsApp

Reference

1 trigger and 57 actions for WhatsApp workflows.

01. Triggers

Start a workflow when something happens in WhatsApp

Each trigger lists the event it fires on, the data it sends, and a template you can use it in.

Webhook

1 trigger

Real-time push from the source.

Webhook★ Featured

WHATSAPP_MESSAGE_STATUS_UPDATED_TRIGGER

Fires when a WhatsApp message delivery status changes (such as sent, delivered, or read). This trigger requires you to configure a webhook endpoint to receive real-time status notifications from WhatsApp, as the system cannot directly poll for status updates.

4 config fields3 output fields
02. Operations

Act on WhatsApp from a workflow

Operations are the actions a workflow can take in WhatsApp, grouped by category. Each lists its method, parameters, and a template you can drop it into.

Account

3 operations

Retrieve and manage your WhatsApp business account details, including registered phone numbers and business profile information. Use these operations to verify your account setup and access the phone number IDs needed for sending messages.

Action

Get business profile

WHATSAPP_GET_BUSINESS_PROFILE

Retrieve your WhatsApp Business profile information including your business description, address, website, and contact details. Use this to view and manage the public-facing information customers see when they interact with your WhatsApp Business account.

2 input
Action

Get phone number

WHATSAPP_GET_PHONE_NUMBER

Retrieve detailed information about your WhatsApp Business phone number, including its verification status, quality rating, and throughput limits. Use this to verify your phone number is properly configured and understand its capabilities.

2 input
Action

Get phone numbers

WHATSAPP_GET_PHONE_NUMBERS

Retrieve all phone numbers connected to your WhatsApp Business Account, including their verification status and messaging capacity. Use this to identify which phone numbers are available for sending messages and manage multiple business lines.

2 input

Media

2 operations

Upload media files to WhatsApp and retrieve metadata about stored media assets. These operations support attaching images, videos, documents, and audio to your messages for richer customer communication.

Action

Get media info

WHATSAPP_GET_MEDIA_INFO

Retrieve metadata and download links for media files shared in WhatsApp conversations, including file type, size, and security information. This enables you to access and verify media content that customers or colleagues have sent you.

1 input
Action

Upload media

WHATSAPP_UPLOAD_MEDIA

Upload media files to WhatsApp servers and receive a reusable media ID for sending images, videos, documents, audio, and stickers to contacts. This enables you to prepare and organize multimedia content for WhatsApp messaging campaigns.

3 input

Messages

8 operations

Send various types of messages to WhatsApp contacts, including templated messages, interactive menus, location data, text, contact cards, and media files. This is the core category for delivering notifications, confirmations, and interactive content to your audience.

Action★ Featured

Send media

WHATSAPP_SEND_MEDIA

Send images, videos, or documents to WhatsApp contacts who have messaged you first, enabling you to share visual content and files directly through WhatsApp conversations.

6 input
Action★ Featured

Send message

WHATSAPP_SEND_MESSAGE

Send text messages directly to WhatsApp users who have recently engaged with your business, enabling direct communication without email or phone calls.

5 input
Action★ Featured

Send template message

WHATSAPP_SEND_TEMPLATE_MESSAGE

Send pre-approved WhatsApp message templates to customers, enabling you to deliver consistent, branded communications at scale without building messages from scratch.

6 input
Action

Send contacts

WHATSAPP_SEND_CONTACTS

Share one or multiple contact details directly via WhatsApp with recipients who have already started a conversation with you.

5 input
Action

Send interactive buttons

WHATSAPP_SEND_INTERACTIVE_BUTTONS

Send interactive button messages to WhatsApp users, allowing them to quickly respond by tapping predefined options instead of typing. Ideal for streamlining customer interactions and collecting structured responses.

7 input
Action

Send interactive list

WHATSAPP_SEND_INTERACTIVE_LIST

Send an interactive menu with organized options to WhatsApp users, allowing them to tap and select from a structured list of choices. Perfect for presenting multiple options like products, services, or workflow steps in a conversational format.

8 input
Action

Send location

WHATSAPP_SEND_LOCATION

Share precise location information with customers via WhatsApp, including coordinates, location name, and address to help them find your business or delivery destination.

7 input
Action

Send media by

WHATSAPP_SEND_MEDIA_BY_ID

Send images, videos, or documents to customers via WhatsApp using a media ID that's already stored on WhatsApp servers, providing faster delivery than uploading new media each time.

7 input

Templates

4 operations

Create, manage, and monitor message templates that ensure compliance with WhatsApp's messaging policies. Use these operations to build reusable message formats, check approval status, and maintain your library of pre-approved communications.

Action★ Featured

Create message template

WHATSAPP_CREATE_MESSAGE_TEMPLATE

Set up reusable message templates for your WhatsApp Business Account that comply with WhatsApp's policies, enabling you to send marketing messages and messages outside the standard conversation window once approved.

8 input
Action

Delete message template

WHATSAPP_DELETE_MESSAGE_TEMPLATE

Permanently remove a message template from your WhatsApp Business Account to clean up unused templates and maintain an organized template library.

3 input
Action

Get message templates

WHATSAPP_GET_MESSAGE_TEMPLATES

Retrieve all pre-approved message templates associated with your WhatsApp Business Account to see what templates are available for sending messages outside the 24-hour customer conversation window.

8 input
Action

Get template status

WHATSAPP_GET_TEMPLATE_STATUS

Check the approval status and details of your WhatsApp message templates to see if they're ready to use or need revision. This helps you track which pre-approved messages you can send to customers.

2 input

Development

40 operations
Action

Block WhatsApp Users

WHATSAPP_BLOCK_USERS

Block one or more WhatsApp users to prevent them from sending messages to your business phone number.

2 input
Action

Configure WhatsApp Conversational Automation

WHATSAPP_CONFIGURE_CONVERSATIONAL_AUTOMATION

Configure conversational automation settings for a WhatsApp Business phone number.

4 input
Action

Create QR Code

WHATSAPP_CREATE_QR_CODE

Create a new QR code with a prefilled message for a WhatsApp Business phone number.

3 input
Action

Create upload session for WhatsApp

WHATSAPP_CREATE_UPLOAD_SESSION

Create a resumable upload session for large file uploads to WhatsApp.

3 input
Action

Create WhatsApp Flow

WHATSAPP_CREATE_FLOW

Create a new WhatsApp Flow for the WhatsApp Business Account.

5 input
Action

Create WhatsApp Max Price Agreement

WHATSAPP_CREATE_MAX_PRICE_AGREEMENTS

Create a max price agreement for WhatsApp marketing messages pricing.

6 input
Action

Delete QR Code

WHATSAPP_DELETE_QR_CODE

Delete a specific QR code from a WhatsApp Business phone number.

2 input
Action

Delete WhatsApp Media

WHATSAPP_DELETE_MEDIA

Delete a WhatsApp media file previously uploaded via the Media API.

1 input
Action

Deregister WhatsApp Business Phone Number

WHATSAPP_DEREGISTER_PHONE

Deregister a WhatsApp Business phone number from the Cloud API.

1 input
Action

Get Business Encryption

WHATSAPP_GET_BUSINESS_ENCRYPTION

Retrieve the WhatsApp Business public key and its signature verification status.

2 input
Action

Get client WhatsApp Business Accounts

WHATSAPP_GET_CLIENT_BUSINESS_ACCOUNTS

Retrieve WhatsApp Business Accounts shared with or managed by a business portfolio.

7 input
Action

Get Flow Assets

WHATSAPP_GET_FLOW_ASSETS

List assets associated with a WhatsApp Flow.

1 input
Action

Get Join Requests

WHATSAPP_GET_JOIN_REQUESTS

Get all pending join requests for a WhatsApp group.

4 input
Action

Get message template library

WHATSAPP_GET_TEMPLATE_LIBRARY

Browse the pre-built message template library for WhatsApp Business Account.

7 input
Action

Get owned WhatsApp Business Accounts

WHATSAPP_GET_OWNED_BUSINESS_ACCOUNTS

Retrieve WhatsApp Business Accounts owned by a business portfolio.

8 input
Action

Get Subscribed Apps

WHATSAPP_GET_SUBSCRIBED_APPS

Get all applications currently subscribed to webhooks for a WhatsApp Business Account.

2 input
Action

Get WhatsApp Business Account Activities

WHATSAPP_GET_ACTIVITIES

Retrieve activity history for a WhatsApp Business Account.

8 input
Action

Get WhatsApp Business Account Details

WHATSAPP_GET_BUSINESS_ACCOUNT_DETAILS

Retrieve comprehensive details about a WhatsApp Business Account (WABA).

2 input
Action

Get WhatsApp Business Compliance Info

WHATSAPP_GET_BUSINESS_COMPLIANCE_INFO

Retrieve comprehensive business compliance information for a WhatsApp Business phone number.

2 input
Action

Get WhatsApp Cloud API Settings

WHATSAPP_GET_SETTINGS

Get Cloud API settings for a WhatsApp Business phone number.

2 input
Action

Get WhatsApp Commerce Settings

WHATSAPP_GET_COMMERCE_SETTINGS

Get commerce settings for a WhatsApp Business phone number.

1 input
Action

Get WhatsApp Message History

WHATSAPP_GET_MESSAGE_HISTORY

Retrieve message history for a WhatsApp Business phone number.

6 input
Action

Get WhatsApp Schedules

WHATSAPP_GET_SCHEDULES

Retrieve campaign schedules associated with a WhatsApp Business Account.

7 input
Action

List qr codes

WHATSAPP_LIST_QR_CODES

Get a list of all QR codes for a WhatsApp Business phone number.

6 input
Action

List WhatsApp Flows

WHATSAPP_LIST_FLOWS

List all WhatsApp Flows associated with the WhatsApp Business Account.

3 input
Action

List WhatsApp Groups

WHATSAPP_LIST_GROUPS

List all WhatsApp groups associated with a business phone number.

4 input
Action

List WhatsApp Solutions

WHATSAPP_LIST_SOLUTIONS

Retrieve a paginated list of Multi-Partner Solutions for a WhatsApp Business Account.

5 input
Action

Publish WhatsApp Flow

WHATSAPP_PUBLISH_FLOW

Publish a WhatsApp Flow to make it available for use.

1 input
Action

Register WhatsApp Business Phone Number

WHATSAPP_REGISTER_PHONE

Register a WhatsApp Business phone number for use with WhatsApp Cloud API.

6 input
Action

Remove Assigned User from WhatsApp Business Account

WHATSAPP_REMOVE_ASSIGNED_USER

Remove a user's access from the WhatsApp Business Account.

2 input
Action

Set WhatsApp Two-Step Verification PIN

WHATSAPP_SET_TWO_STEP_VERIFICATION

Set or reset the two-step verification PIN for a WhatsApp Business phone number.

2 input
Action

Subscribe to WABA Webhooks

WHATSAPP_SUBSCRIBE_APP

Subscribe your application to receive webhook notifications for a WhatsApp Business Account (WABA).

3 input
Action

Unsubscribe from WABA Webhooks

WHATSAPP_UNSUBSCRIBE_APP

Unsubscribe your application from webhook events for a WhatsApp Business Account (WABA).

1 input
Action

Update Flow JSON

WHATSAPP_UPDATE_FLOW_JSON

Update the Flow JSON configuration for a WhatsApp Flow.

4 input
Action

Update WhatsApp Business Profile

WHATSAPP_UPDATE_BUSINESS_PROFILE

Update WhatsApp Business Profile information including business details, contact information, and profile settings.

9 input
Action

Update WhatsApp Cloud API Settings

WHATSAPP_UPDATE_SETTINGS

Update Cloud API settings for a WhatsApp Business phone number.

5 input
Action

Update WhatsApp commerce settings

WHATSAPP_UPDATE_COMMERCE_SETTINGS

Set or update commerce settings for a WhatsApp Business phone number.

3 input
Action

Update WhatsApp Flow Metadata

WHATSAPP_UPDATE_BUSINESS_ACCOUNT

Update metadata for a WhatsApp Flow including its name, categories, and endpoint URI.

4 input
Action

Upsert message template

WHATSAPP_UPSERT_MESSAGE_TEMPLATE

Create or update a message template for the WhatsApp Business Account.

5 input
Action

Verify Phone Number OTP Code

WHATSAPP_VERIFY_CODE

Verify the OTP code for a pre-verified phone number.

2 input
What now

Use WhatsApp in a workflow

Drop a trigger and an action into a template; approve from your phone; the workflow runs.