> For the complete documentation index, see [llms.txt](https://docs.digibee.com/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digibee.com/documentation/connectors-and-triggers/connectors/enterprise-applications/whatsapp.md).

# WhatsApp

Discover more about the WhatsApp connector and how to use it on the Digibee Integration Platform.

**WhatsApp** allows you to send messages to WhatsApp.

## **Parameters**

Take a look at the configuration parameters for the connector. Parameters supported by [Double Braces expressions](/documentation/connectors-and-triggers/double-braces/overview.md) are marked with `(DB)`.

{% hint style="info" %}
This connector supports the **Alias** parameter, which allows you to save its output and reference it later in the flow using Double Braces expressions. [Learn more](/documentation/connectors-and-triggers/double-braces/how-to-reference-data-using-double-braces/previous-steps-access.md).
{% endhint %}

### **General tab**

<table data-full-width="true"><thead><tr><th>Parameter</th><th>Description</th><th>Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>Account</strong></td><td>The <a href="/documentation/development-cycle/build-overview/accounts.md">account used by the connector</a>. Supported type: <strong>OAuth Bearer</strong>.</td><td>N/A</td><td>Account</td></tr><tr><td><strong>Phone Number ID</strong> <code>(DB)</code></td><td>The ID associated with your WhatsApp Business phone number, available in the WhatsApp Business dashboard.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Fail On Error</strong></td><td>If enabled, interrupts the pipeline execution when an error occurs. If disabled, execution continues, but the <code>"success"</code> property will be set to <code>false</code>.</td><td>False</td><td>Boolean</td></tr></tbody></table>

### **Optional tab**

<table data-full-width="true"><thead><tr><th>Parameter</th><th>Description</th><th>Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>API Version</strong> <code>(DB)</code></td><td>Specifies the version of the Facebook Graph API to use.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Base URI</strong><code>(DB)</code></td><td>Optional. Defines a custom base URI. Useful, for example, when testing the connector with a mock WhatsApp API.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Webhook Path</strong> <code>(DB)</code></td><td>The path where the connector will receive webhook requests.</td><td>/messages</td><td>String</td></tr><tr><td><strong>To</strong> <code>(DB)</code></td><td>The recipient's phone number, including the country code, area code, and number (for example, 5511999998888)</td><td>N/A</td><td>String</td></tr><tr><td><strong>Message</strong> <code>(DB)</code></td><td>The text content of the message to be sent.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Preview URL</strong></td><td>If the message includes a URL, enabling this option displays a link preview in the message.</td><td>False</td><td>Boolean</td></tr></tbody></table>

### **Documentation tab**

<table data-full-width="true"><thead><tr><th>Parameter</th><th>Description</th><th>Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>Documentation</strong></td><td>Section for documenting any necessary information about the connector configuration and business rules.</td><td>N/A</td><td>String</td></tr></tbody></table>

## **Messages flow**

### **Input**

The connector accepts any input message, being able to use it through Double Braces.

### **Output**

The connector returns a JSON object with the following structure:

```json
{
  "success": true,
  "body": {
    "messages": {
      "empty": false
    },
    "contacts": {
      "empty": false
    },
    "messagingProduct": "whatsapp"
  }
}
```

**Fields description:**

* **`success`**: Indicates whether the execution was successful. A value of `true` means the request was processed without errors.
* **`body.messages.empty`**: A boolean flag that shows whether the list of messages is empty. A value of `false` means the connector successfully processed at least one message.
* **`body.contacts.empty`**: Similar to the `messages` field, this flag indicates whether any contacts were returned. A value of `false` confirms that at least one contact was processed.
* **`body.messagingProduct`**: Specifies the messaging platform used. In this case, the value `"whatsapp"` confirms the request was handled by the WhatsApp Business API.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.digibee.com/documentation/connectors-and-triggers/connectors/enterprise-applications/whatsapp.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.