> ## Documentation Index
> Fetch the complete documentation index at: https://docs.noxus.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# WhatsApp

> Deploy your agent to WhatsApp Business and chat with customers on the world's largest messaging app

Deploy your agent to WhatsApp via the **WhatsApp Business Cloud API** (Meta). Once connected, users can text the business phone number and the agent will reply — with text, media attachments, and typing indicators.

## Setting Up the WhatsApp Deployment

WhatsApp deployments use Meta's Cloud API. You need a WhatsApp Business Account (WABA), a verified phone number, and a system-user access token with WhatsApp permissions.

<Steps>
  <Step title="Create a WhatsApp Business Account">
    In [Meta Business Suite](https://business.facebook.com), create or select a Business Account and add **WhatsApp** to it. Register and verify a phone number — Noxus will send messages from this number.
  </Step>

  <Step title="Collect your IDs">
    In your Meta Business account, open the WhatsApp configuration for your app and copy:

    * **Phone Number ID** — unique identifier for the registered business phone number.
    * **Business Account ID** — the WABA ID.
  </Step>

  <Step title="Generate an access token">
    Create a **system user** on Meta Business and generate a permanent access token with the `whatsapp_business_messaging` and `whatsapp_business_management` scopes. Copy the token.
  </Step>

  <Step title="Pick a webhook verify token">
    Choose any long random string — this is the **Webhook Verify Token**. You will give it to both Noxus and Meta so they can authenticate each other on incoming webhook requests.
  </Step>

  <Step title="Enter credentials in Noxus">
    Back in Noxus, create a new WhatsApp connection and fill in the four fields:

    * **Phone Number ID**
    * **Business Account ID**
    * **Access Token**
    * **Webhook Verify Token**

    Click **Connect** — Noxus will call the Facebook Graph API (v22.0) to verify the phone number and the access token.
  </Step>

  <Step title="Configure the webhook in Meta">
    On your WhatsApp configuration page in Meta, set the **Callback URL** to the webhook URL shown in Noxus and paste the same **Webhook Verify Token** you used above. Subscribe to the `messages` webhook field so the agent receives incoming messages.
  </Step>
</Steps>

<Warning>
  Your WhatsApp Business Account must be approved by Meta for production messaging. Until it is, WhatsApp caps you at a limited number of test recipients and test conversations.
</Warning>

## Deployment Settings

Once your WhatsApp connection is established, configure how the agent behaves. Settings are organized into the sections below.

### Deployment

| Field       | Description                                                                                                                  |
| :---------- | :--------------------------------------------------------------------------------------------------------------------------- |
| **Status**  | Toggle the deployment **Online** or **Offline**. When online, the agent replies to incoming WhatsApp messages automatically. |
| **Version** | The published agent version this deployment uses.                                                                            |

<Note>
  A published **version** is required before you can set a deployment to Online. Switch to **Offline** to edit configuration.
</Note>

### Configuration

| Field                   | Description                                                                                                                                  |
| :---------------------- | :------------------------------------------------------------------------------------------------------------------------------------------- |
| **WhatsApp Connection** | The WhatsApp connection to use. Manage connections in your workspace's connections settings.                                                 |
| **Custom Instructions** | Per-deployment instructions appended to the agent's system prompt (e.g. `"Always respond in English"` or `"Never ask for payment details"`). |

### Conversation Triggers

A new conversation starts when **all** specified fields match an incoming message. Leave a field empty to match any value.

| Field                      | Description                                                                                                                                                                  |
| :------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Phone Number Filter**    | Only respond to messages from this specific sender phone number (e.g. `+1234567890`). Leave empty to respond to everyone who messages your business number.                  |
| **Keyword**                | One or more keywords that must appear in the message.                                                                                                                        |
| **Chunk messages**         | When on, long agent responses are automatically split into smaller, easier-to-read WhatsApp messages. Recommended — WhatsApp has a strict 2,048-character per-message limit. |
| **Show writing indicator** | When on, WhatsApp shows a "typing…" state while the agent composes a reply.                                                                                                  |

### Reply Behavior

| Field          | Description                                                                                                                                           |
| :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Reply mode** | `Auto` — reply directly to the sender. `Tool-based` — nothing is sent automatically; the agent must explicitly call the `send_message` tool to reply. |

<Note>
  WhatsApp does not support threads or reactions, so the **Thread** reply mode and the **Batch messages** / **Quiet period** settings are not available on this channel.
</Note>

### Rate Limits

| Field                              | Description                                                                                              |
| :--------------------------------- | :------------------------------------------------------------------------------------------------------- |
| **Max messages per minute**        | Limit how many messages the agent sends per minute. `0` for unlimited.                                   |
| **Max new conversations per hour** | Limit how many new conversations can be started per hour. `0` for unlimited.                             |
| **Conversation timeout (minutes)** | After this many minutes of inactivity, the next message starts a fresh conversation. `0` for no timeout. |

### Display

| Field               | Description                                                               |
| :------------------ | :------------------------------------------------------------------------ |
| **Show thinking**   | Display the agent's reasoning steps in WhatsApp messages. Off by default. |
| **Show tool calls** | Display tool call status in WhatsApp messages. Off by default.            |
| **Show sources**    | Display source citations in WhatsApp messages. On by default.             |
