# WhatsApp-Meta

## **Introduction**

This document provides comprehensive and up-to-date instructions for integrating **WhatsApp** into **Autom Mate**. The integration allows users to interact with WhatsApp’s messaging platform, enabling operations like sending text, media, interactive buttons, and collecting user responses directly within Autom Mate workflows.

Through this integration, Autom Mate users can automate processes such as customer communication, approval collection, and real-time notifications—all without writing additional code.

***

## **What is WhatsApp?**

WhatsApp is a globally used messaging platform designed to enable fast, secure, and direct communication between individuals and businesses. With its Business API, it provides enterprise-grade capabilities for sending messages, collecting responses, and delivering interactive user experiences at scale.

WhatsApp is used across industries to drive customer engagement, support service workflows, and streamline operations. With this integration, Autom Mate users can easily embed WhatsApp interactions into their automated workflows.

***

## **Automate Integration with WhatsApp**

Under the **Integration Library**, Autom Mate provides several built-in actions that allow seamless interaction with WhatsApp, including:

* **Text** – Sends simple or question-based text messages.
* **Send Media** – Sends images or videos with captions.
* **Button Message** – Sends a message with up to 3 predefined buttons.
* **List Message** – Sends a structured list of up to 10 items.
* **Dynamic List Message** – Sends a list dynamically populated via API.

These actions allow users to send messages, receive structured responses, and process input dynamically within workflows.

***

#### 🔐 **Prerequisite**

Before using this integration, ensure you have the appropriate credentials stored securely in Autom Mate:

* Navigate to the [**Vault** ](/userguide/product-features/management/vault.md)page in Autom Mate.
* Create a new Vault item containing your WhatsApp API credentials.
* Use this credential in the **Credential** field within the action configuration.

This ensures secure communication and credential management across your automation processes.

***

## **Using the Integration**

To use the WhatsApp integration in Autom Mate:

* **Select the WhatsApp Action**\
  Choose from pre-built actions like "Text", "Send Media", or "Button Message" in the Integration Library.
* **Fill in Required Fields**\
  Provide necessary inputs like message content, media link, or API endpoint depending on the selected action.
* **Use Variables in Subsequent Actions**\
  After executing the action, you can use the assigned output variables in downstream actions, such as conditional flows, data updates, or external system interactions.

## How To Use Actions

### **Button Message**

#### **Description and Purpose**

The **WhatsApp - Button Message** action enables Autom Mate users to send structured, interactive messages via WhatsApp that include up to three tappable button options. This facilitates quick and predefined user responses—ideal for workflows involving approvals, confirmations, customer service, and other interactive decisions.

This action supports higher engagement and response rates by reducing user effort and making interactions more dynamic.

***

#### **Usage Instructions**

{% stepper %}
{% step %}
**Specify Credential**

**Credential (Required)**\
Provide the credential that enables Autom Mate to send messages via your WhatsApp Business API instance.
{% endstep %}

{% step %}
**Compose Message Content**

**Header (Optional)**\
Short title displayed at the top of the message.\
\&#xNAN;*Character limit: 60*
{% endstep %}

{% step %}
**Body (Required)**

Main content of the message that explains the context or question.\
\&#xNAN;*Character limit: 1024*
{% endstep %}

{% step %}
**Footer (Optional)**

A small note or instruction shown below the buttons.\
\&#xNAN;*Character limit: 60*
{% endstep %}

{% step %}
**Configure Button Messages**

**Button Messages (Required)**\
Add 1 to 3 buttons the recipient can click to respond. Each button represents a predefined response.\
\&#xNAN;*Maximum: 3 buttons*\
\&#xNAN;*Each button's text must be ≤ 24 characters.*

> **Example button texts**
>
> * `"Approve"`
> * `"Reject"`
> * `"Request Info"`
>   {% endstep %}

{% step %}
**Execute the Action**

When run, the message will be sent to the recipient with the specified interactive buttons. User interaction (selected button) is stored in the system-defined string variable.
{% endstep %}
{% endstepper %}

***

#### **Inputs**

<table><thead><tr><th width="190">Field</th><th>Description</th></tr></thead><tbody><tr><td>Credential</td><td>WhatsApp API credential for authentication (e.g., token or key)</td></tr><tr><td>Header</td><td>Short message title (max 60 characters)</td></tr><tr><td>Body (Required)</td><td>Main message content (max 1024 characters)</td></tr><tr><td>Footer</td><td>Optional footer message (max 60 characters)</td></tr><tr><td>Button Messages</td><td>Up to 3 button labels (each ≤ 24 characters)</td></tr></tbody></table>

***

#### **Outputs**

<table><thead><tr><th width="190">Field</th><th>Description</th></tr></thead><tbody><tr><td>Response</td><td>A string variable containing the title of the button clicked by the user</td></tr></tbody></table>

> **Note:** The output can be used in conditional branches to drive workflow logic based on user response. *This field is a string variable that holds the title value*

***

### **Dynamic List Message**

#### **Description and Purpose**

The **WhatsApp - Dynamic List Message** action allows Autom Mate users to send a WhatsApp message with a list of dynamic options retrieved from an external API using either `GET` or `POST` method. The data source can be secured via `Basic` authentication (username/password) or `OAuth2` credentials managed in Autom Mate Vault. This action enhances interaction by letting users choose from real-time generated options and use their selection in automated workflows.

***

#### **Usage Instructions**

{% stepper %}
{% step %}
**Select WhatsApp Credential**

**Credential (Required)**\
Select the WhatsApp credential that allows Autom Mate to send the message.
{% endstep %}

{% step %}
**Header (Required)**

Provide a short title for the message.\
\&#xNAN;*Character limit: 60*
{% endstep %}

{% step %}
**Body (Required)**

Write the main body text explaining the list selection.\
\&#xNAN;*Character limit: 1024*
{% endstep %}

{% step %}
**Footer (Optional)**

Provide a small note or context below the list.\
\&#xNAN;*Character limit: 60*
{% endstep %}

{% step %}
**Button Text (Required)**

Define the label shown on the interactive button.\
\&#xNAN;*Character limit: 20*
{% endstep %}

{% step %}
**Request URI (Required)**

Enter the full URL of the API endpoint that provides list data.
{% endstep %}

{% step %}
**Method**

Choose `GET` or `POST`.
{% endstep %}

{% step %}
**Authentication**

* **Basic Authentication**
  * **Username (Required):** Use a custom string or reference from Vault.
  * **Password (Required):** Use a custom string or reference from Vault.
* **OAuth2**
  * **Custom OAuth Credential:** Select an OAuth2 credential defined in Autom Mate [Vault](/userguide/product-features/management/vault.md).
    {% endstep %}

{% step %}
**Header (Optional)**

Define any custom headers as key-value pairs (e.g., API keys, tokens).
{% endstep %}

{% step %}
**Query Params (Optional)**

Define additional query parameters as key-value pairs.
{% endstep %}

{% step %}
**Response Title Path (Required)**

Provide the path to extract the title of each list item. Leave empty if the title is at the root.\
\&#xNAN;*Character limit: 24*
{% endstep %}

{% step %}
**Response Description Path (Optional)**

Provide the path to extract the description of each list item.\
\&#xNAN;*Character limit: 72*
{% endstep %}
{% endstepper %}

***

#### **Inputs**

<table><thead><tr><th width="262">Field</th><th>Description</th></tr></thead><tbody><tr><td>Credential</td><td>WhatsApp credential used for sending the message</td></tr><tr><td>Header</td><td>Title of the list message (max 60 characters)</td></tr><tr><td>Body</td><td>Message body content (max 1024 characters)</td></tr><tr><td>Footer</td><td>Footer text (max 60 characters)</td></tr><tr><td>Button Text</td><td>Button label (max 20 characters)</td></tr><tr><td>Request URI</td><td>API endpoint URL to retrieve the list</td></tr><tr><td>Method</td><td>HTTP method: <code>GET</code> or <code>POST</code></td></tr><tr><td>Authentication</td><td>Select Basic or OAuth2 for secured access</td></tr><tr><td>Username</td><td>(Basic) Username for authentication</td></tr><tr><td>Password</td><td>(Basic) Password for authentication</td></tr><tr><td>Custom OAuth Credential</td><td>(OAuth2) OAuth credential from Vault</td></tr><tr><td>Header</td><td>Custom header key-value pairs</td></tr><tr><td>Query Params</td><td>Custom query parameter key-value pairs</td></tr><tr><td>Response Title Path</td><td>JSON path to extract item title (max 24 characters)</td></tr><tr><td>Response Description Path</td><td>JSON path to extract item description (max 72 characters)</td></tr></tbody></table>

***

#### **Outputs**

<table><thead><tr><th width="262">Field</th><th>Description</th></tr></thead><tbody><tr><td>Response</td><td>String variable holding the selected list item's title</td></tr></tbody></table>

***

### **List Message**

#### **Description and Purpose**

The **WhatsApp - List Message** action enables Autom Mate users to send a WhatsApp message containing a static list of predefined options. Users can select from this list, and the selected value is returned as a response variable. This action is ideal for use cases such as predefined service selections, product options, or user preference submissions.

***

#### **Usage Instructions**

{% stepper %}
{% step %}
**Select WhatsApp Credential**

**Credential (Required):**\
Select the WhatsApp credential that allows Autom Mate to send the message.
{% endstep %}

{% step %}
**Header (Required)**

Provide a short title for the message.\
\&#xNAN;*Character limit: 60*
{% endstep %}

{% step %}
**Body (Required)**

Write the main message text.\
\&#xNAN;*Character limit: 1024*
{% endstep %}

{% step %}
**Footer (Optional)**

Add a note or additional information below the list.\
\&#xNAN;*Character limit: 60*
{% endstep %}

{% step %}
**Button Text (Required)**

Specify the label shown on the button to open the list.\
\&#xNAN;*Character limit: 20*
{% endstep %}

{% step %}
**List Messages (Required)**

* Add one or more list items to display to the user.
* Click **"Create List Item"** to define a new entry.
* Each list item must include a **Title** (required, max 24 characters) and may include an optional
* **Description** (max 72 characters).
* You can add up to 10 list items in total.
  {% endstep %}
  {% endstepper %}

***

#### **Inputs**

<table><thead><tr><th width="235">Field</th><th>Description</th></tr></thead><tbody><tr><td>Credential</td><td>WhatsApp credential used to send the message</td></tr><tr><td>Header</td><td>Title of the list message (max 60 characters)</td></tr><tr><td>Body</td><td>Body content of the message (max 1024 characters)</td></tr><tr><td>Footer</td><td>Footer note (optional, max 60 characters)</td></tr><tr><td>Button Text</td><td>Button label (max 20 characters)</td></tr><tr><td>List Messages</td><td>List of up to 10 items, each with a title and optional description</td></tr></tbody></table>

***

#### **Outputs**

<table><thead><tr><th width="235">Field</th><th>Description</th></tr></thead><tbody><tr><td>Response</td><td>A string variable that holds the selected list item’s title</td></tr></tbody></table>

***

### **Send Media**

#### **Description and Purpose**

The **WhatsApp - Send Media** action allows Autom Mate users to send multimedia messages via WhatsApp. Supported media types include images and videos. This action is commonly used in workflows that require visual communication—such as confirmations, instructions, alerts, or promotional content.

***

#### **Usage Instructions**

{% stepper %}
{% step %}
**Select WhatsApp Credential**

**Credential (Required):**\
Select the WhatsApp credential that allows Autom Mate to send the message.
{% endstep %}

{% step %}
**Label (Optional)**

Add a custom label for internal identification or reporting purposes.
{% endstep %}

{% step %}
**Media Type**

Select the type of media to be sent. Available options:

* `Image`
* `Video`
  {% endstep %}

{% step %}
**Link (Required)**

Provide the publicly accessible URL of the media file.

* ***Image formats supported:*** *`jpeg`, `png`*
* ***Video formats supported:*** *`mp4`, `3gpp`*
* The link must be HTTPS and directly downloadable.
  {% endstep %}

{% step %}
**Caption (Optional)**

Add an optional caption that will be displayed under the media.
{% endstep %}
{% endstepper %}

***

#### **Inputs**

<table><thead><tr><th width="190">Field</th><th>Description</th></tr></thead><tbody><tr><td>Credential</td><td>WhatsApp credential used for sending the message</td></tr><tr><td>Label</td><td>Optional label for internal tracking or logging</td></tr><tr><td>Media Type</td><td>Select <code>Image</code> or <code>Video</code></td></tr><tr><td>Link</td><td>Public HTTPS link to the media (image: <code>jpeg/png</code>, video: <code>mp4/3gpp</code>)</td></tr><tr><td>Caption</td><td>Optional message displayed below the media</td></tr></tbody></table>

***

#### **Outputs**

<table><thead><tr><th width="190">Field</th><th>Description</th></tr></thead><tbody><tr><td>Response</td><td>A string variable that confirms media message delivery status</td></tr></tbody></table>

***

### **Text**

#### **Description and Purpose**

The **WhatsApp - Text** action allows Autom Mate users to send a plain text message to a WhatsApp contact. This action can be used for simple notifications, updates, confirmations, or to ask a direct question. Optionally, the message can be flagged as a question to collect a response from the user.

***

#### **Usage Instructions**

{% stepper %}
{% step %}
**Select WhatsApp Credential**

**Credential (Required)**\
Select the WhatsApp credential that allows Autom Mate to send the message.
{% endstep %}

{% step %}
**Label (Optional)**

Provide a label for internal tracking or categorization.
{% endstep %}

{% step %}
**Message**

Enter the message text to be sent.\
\&#xNAN;*Character limit: 4096*
{% endstep %}

{% step %}
**Is Question? (Optional)**

If checked, the message is treated as a question, and the recipient’s reply will be captured in the response variable.
{% endstep %}
{% endstepper %}

***

#### **Inputs**

<table><thead><tr><th width="250">Field</th><th>Description</th></tr></thead><tbody><tr><td>Credential</td><td>WhatsApp credential used for sending the message</td></tr><tr><td>Label</td><td>Optional label for internal use</td></tr><tr><td>Message</td><td>Text content of the message (max 4096 characters)</td></tr><tr><td>Is Question?</td><td>If enabled, captures user reply to the message</td></tr></tbody></table>

***

#### **Outputs**

<table><thead><tr><th width="250">Field</th><th>Description</th></tr></thead><tbody><tr><td>Response</td><td>A string variable that holds the reply text from the user</td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.autommate.com/userguide/libraries/integration/whatsapp-meta.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.