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

# Whatsapp trigger

# WhatsApp Trigger

The **WhatsApp Trigger** starts an orchestration when an incoming WhatsApp message is received on a connected number.

<img src="https://mintcdn.com/subverse-611dde60/UZLalX8VX2i72yfQ/images/agentverse/whatsapp-trigger-node.png?fit=max&auto=format&n=UZLalX8VX2i72yfQ&q=85&s=f49f4396ea07400edb17f3d6b73e8635" alt="WhatsApp Trigger Node" width="802" height="1296" data-path="images/agentverse/whatsapp-trigger-node.png" />

***

## Use Cases

* Build AI-powered WhatsApp bots using AgentVerse
* Automate customer support workflows triggered by WhatsApp messages
* Route incoming messages based on content or sender
* Integrate WhatsApp as an input channel for AI agents

***

## Credentials

This node requires a **WhatsApp** credential configured with your WhatsApp Business API access token and phone number ID.

To create a credential:

1. Go to **Settings → Credentials → New Credential**
2. Select **WhatsApp**
3. Enter your WhatsApp Business API access token and phone number ID

***

## Node Reference

### Parameters

| Parameter      | Type         | Description                                                             |
| -------------- | ------------ | ----------------------------------------------------------------------- |
| **Credential** | Credential   | Select or create a WhatsApp credential                                  |
| **Trigger On** | Multi-select | Event types to listen for (e.g. `Messages`, `Template Category Update`) |

### Trigger On Options

| Option                     | Description                                      |
| -------------------------- | ------------------------------------------------ |
| `Messages`                 | Fires when a text or media message is received   |
| `Template Category Update` | Fires when a message template's category changes |

### Options

| Option                             | Description                                                                                                                                                                                                                                      |
| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Receive Message Status Updates** | Filter which delivery status updates trigger the orchestration: `All`, `Sent`, `Delivered`, `Read`. WhatsApp sends a notification when a message status changes (e.g. from Sent → Delivered). Set this to avoid multiple executions per message. |

### Webhook URL

The WhatsApp Trigger displays a unique **Webhook URL** in the node panel. Configure this URL in your WhatsApp Business API app settings under **Webhooks**.

***

## Output Data

The trigger outputs the incoming message payload:

```json theme={null}
{
  "from": "919876543210",
  "to": "911234567890",
  "messageId": "wamid.XXXXXXXXXXXX",
  "type": "text",
  "text": {
    "body": "Hello, I need help with my order."
  },
  "timestamp": "1678901234"
}
```

For media messages:

```json theme={null}
{
  "from": "919876543210",
  "type": "image",
  "image": {
    "id": "media-id",
    "mimeType": "image/jpeg",
    "caption": "Here's my receipt"
  },
  "timestamp": "1678901234"
}
```

Reference fields in downstream nodes:

```
{{ whatsappTrigger.text.body }}
{{ whatsappTrigger.from }}
{{ whatsappTrigger.messageId }}
```

***

## Related Nodes

* [WhatsApp](./whatsapp.md) — Send WhatsApp messages within an orchestration
* [SubVerse Agents](./subverse-agents.md) — Route the message to a SubVerse AI agent
* [AI Agent](./ai-agent.md) — Process the incoming message with an LLM