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

# WhatsApp Message

> Triggered when a WhatsApp message is received. Works like Chat Trigger for AI agents.

# WhatsApp Message

Triggered when a WhatsApp message is received. Works like Chat Trigger for AI agents.

## Properties

| Property   | Value                    |
| ---------- | ------------------------ |
| **Type**   | whatsapp-message-trigger |
| **Family** | Triggers                 |
| **Group**  | WhatsApp                 |

## Parameters

| Name                 | Label                  | Type   | Description                                                                       | Required |
| -------------------- | ---------------------- | ------ | --------------------------------------------------------------------------------- | -------- |
| chatName             | Chat Name              | String | Name for this WhatsApp chat agent                                                 | No       |
| initialMessage       | Initial Message        | String | Initial greeting message (sent when conversation starts)                          | No       |
| autoReply            | Auto-Reply Enabled     | Bool   | Automatically process and reply to messages                                       | No       |
| messageType          | Message Type Filter    | Select |                                                                                   | No       |
| fromFilter           | From Contact Filter    | String | Optional: Only trigger for messages from specific contacts (comma-separated JIDs) | No       |
| includeGroupMessages | Include Group Messages | Bool   | Whether to also trigger for group messages                                        | No       |
| excludeSelfMessages  | Exclude Own Messages   | Bool   | Don't trigger for messages sent by the connected account                          | No       |

## Outputs

| Name            | Label           | Type    | Description                                           |
| --------------- | --------------- | ------- | ----------------------------------------------------- |
| message         | message         | string  | Message content (alias for content)                   |
| sessionId       | sessionId       | string  | Session ID for conversation continuity (uses chatJid) |
| senderId        | senderId        | string  | Sender identifier (senderJid)                         |
| chatNodeId      | chatNodeId      | string  | ID of this trigger node (for history lookup)          |
| messageId       | messageId       | string  | WhatsApp message ID                                   |
| chatJid         | chatJid         | string  | Chat JID (contact or group)                           |
| senderJid       | senderJid       | string  | Sender JID                                            |
| senderName      | senderName      | string  | Sender's push name                                    |
| isFromMe        | isFromMe        | boolean | Whether sent by connected account                     |
| isGroup         | isGroup         | boolean | Whether from a group chat                             |
| messageType     | messageType     | string  | Message type (text, image, video, etc.)               |
| content         | content         | string  | Text content or caption                               |
| mediaUrl        | mediaUrl        | string  | URL to media file if applicable                       |
| mimeType        | mimeType        | string  | MIME type of media                                    |
| quotedMessageId | quotedMessageId | string  | ID of quoted message if reply                         |
| timestamp       | timestamp       | string  | Message timestamp                                     |
| receivedAt      | receivedAt      | string  | Timestamp when message was received                   |
| metadata        | metadata        | object  | Full message metadata                                 |
| files           | files           | array   | Array of media file URLs                              |