n8n-nodes-chatery-whatsapp 0.1.4 → 0.2.0

package/README.md

@@ -2,7 +2,7 @@
 
 ![n8n.io - Workflow Automation](https://raw.githubusercontent.com/n8n-io/n8n/master/assets/n8n-logo.png)
 
-This is an n8n community node for integrating with **Chatery WhatsApp API**. It allows you to automate WhatsApp messaging, manage sessions, retrieve chat history, and handle groups directly from your n8n workflows.
+This is an n8n community node for integrating with **[Chatery WhatsApp API](https://github.com/farinchan/chatery_whatsapp)**. It allows you to automate WhatsApp messaging, manage sessions, retrieve chat history, handle groups, and send bulk messages directly from your n8n workflows.
 
 [n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.
 
@@ -16,6 +16,7 @@ This is an n8n community node for integrating with **Chatery WhatsApp API**. It
 - [Resources & Operations](#resources--operations)
 - [Compatibility](#compatibility)
 - [Usage Examples](#usage-examples)
+- [Links](#links)
 - [License](#license)
 
 ## Installation
@@ -42,8 +43,8 @@ To use this node, you need to configure the **Chatery API** credentials:
 
 | Field | Description |
 |-------|-------------|
-| **URL** | Your Chatery WhatsApp API host URL (e.g., `https://api.chatery.io`) |
-| **API Key** | Your API key for authentication (optional, depending on your setup) |
+| **URL** | Your Chatery WhatsApp API host URL (e.g., `https://api.chatery.app`) |
+| **API Key** | Your API key for authentication (X-Api-Key header) |
 
 ## Nodes
 
@@ -54,18 +55,27 @@ This package includes two nodes:
 A webhook trigger node that listens for WhatsApp events from the Chatery API.
 
 **Supported Events:**
+
 | Event | Description |
 |-------|-------------|
 | `all` | Listen to all events |
-| `message` | New incoming message |
-| `message_ack` | Message acknowledgment (sent, delivered, read) |
-| `message_revoke` | Message deleted/revoked |
-| `presence` | Contact presence update (online, typing, etc.) |
 | `qr` | QR code generated for authentication |
-| `ready` | Session is ready and connected |
-| `disconnected` | Session disconnected |
-| `group_update` | Group information updated |
-| `group_participants` | Group participants changed |
+| `connection.update` | Connection status changed (connected, disconnected) |
+| `message` | New message received |
+| `message.sent` | Message sent confirmation |
+| `message.update` | Message status update (read, delivered) |
+| `message.reaction` | Message reaction added |
+| `message.revoke` | Message deleted/revoked |
+| `presence.update` | Typing, online status |
+| `group.participants` | Group members changed |
+| `group.update` | Group info changed |
+| `chat.update` | Chat updated |
+| `chat.upsert` | New chat created |
+| `chat.delete` | Chat deleted |
+| `contact.update` | Contact updated |
+| `call` | Incoming call |
+| `labels` | Labels updated (business) |
+| `logged.out` | Session logged out |
 
 **Options:**
 - **Session Filter**: Filter events by specific session ID
@@ -80,44 +90,58 @@ The main node for performing WhatsApp operations via HTTP requests.
 
 ## Resources & Operations
 
+### Bulk Resource (NEW!)
+
+Send messages to multiple recipients with background processing.
+
+| Operation | Description |
+|-----------|-------------|
+| **Send Bulk Text** | Send a text message to multiple recipients |
+| **Send Bulk Image** | Send an image to multiple recipients |
+| **Send Bulk Document** | Send a document to multiple recipients |
+| **Get Job Status** | Get status of a bulk messaging job |
+| **Get All Jobs** | Get all bulk messaging jobs |
+
 ### Chat Resource
 
 | Operation | Description |
 |-----------|-------------|
-| **Send Text** | Send a text message to a chat |
-| **Send Image** | Send an image with optional caption |
-| **Send Document** | Send a document/file |
-| **Send Location** | Send a location with coordinates |
-| **Send Contact** | Send a contact card |
-| **Send Button** | Send a message with buttons |
+| **Send Text** | Send a text message (supports replyTo) |
+| **Send Image** | Send an image with optional caption (supports replyTo) |
+| **Send Document** | Send a document/file (supports replyTo) |
+| **Send Location** | Send a location with coordinates (supports replyTo) |
+| **Send Contact** | Send a contact card (supports replyTo) |
+| **Send Button** | Send a message with buttons (supports replyTo) |
 | **Send Presence Update** | Update your presence status |
 | **Check Number** | Check if a number is registered on WhatsApp |
 | **Profile Picture** | Get a contact's profile picture URL |
 | **Contact Info** | Get detailed information about a contact |
 
+> **NEW:** All send operations now support `replyTo` parameter to reply/quote specific messages!
+
 ### Session Resource
 
 | Operation | Description |
 |-----------|-------------|
 | **List** | List all available sessions |
 | **Connect** | Connect/start a new session |
-| **Status** | Get the status of a session |
+| **Get Status** | Get the status of a session |
 | **Update Config** | Update session configuration |
 | **Add Webhook** | Add a webhook URL to receive events |
 | **Remove Webhook** | Remove a webhook from the session |
-| **QR Code** | Get QR code as text for authentication |
-| **QR Image** | Get QR code as image for authentication |
+| **Get QR Code** | Get QR code as text for authentication |
+| **Get QR Image** | Get QR code as image for authentication |
 | **Delete** | Delete/terminate a session |
 
 ### History Resource
 
 | Operation | Description |
 |-----------|-------------|
-| **Overview** | Get an overview of all chats |
-| **Contacts** | Get list of all contacts |
-| **Messages** | Get messages from a specific chat |
-| **Info** | Get detailed information about a chat |
-| **Mark Read** | Mark messages in a chat as read |
+| **Get Overview** | Get an overview of all chats |
+| **Get Contacts** | Get list of all contacts |
+| **Get Messages** | Get messages from a specific chat |
+| **Get Chat Info** | Get detailed information about a chat |
+| **Mark as Read** | Mark messages in a chat as read |
 
 ### Group Resource
 
@@ -125,19 +149,19 @@ The main node for performing WhatsApp operations via HTTP requests.
 |-----------|-------------|
 | **List** | List all groups you're a member of |
 | **Create** | Create a new group |
-| **Metadata** | Get group metadata/information |
+| **Get Metadata** | Get group metadata/information |
 | **Add Participants** | Add participants to a group |
 | **Remove Participants** | Remove participants from a group |
 | **Promote Participants** | Promote participants to admin |
 | **Demote Participants** | Demote admins to regular participants |
 | **Update Subject** | Update group name/subject |
 | **Update Description** | Update group description |
+| **Update Settings** | Set who can send messages or edit group info |
+| **Update Picture** | Update group picture |
 | **Leave** | Leave a group |
-| **Invite Code** | Get group invite code |
-| **Revoke Invite Code** | Revoke and generate new invite code |
-| **Set Who Can Send Message** | Set who can send messages (all/admins only) |
-| **Set Who Can Edit Group** | Set who can edit group info |
-| **Accept Invite** | Join a group using invite code |
+| **Get Invite Code** | Get group invite code |
+| **Revoke Invite** | Revoke and generate new invite code |
+| **Join** | Join a group using invite code |
 
 ## Compatibility
 
@@ -153,52 +177,47 @@ The main node for performing WhatsApp operations via HTTP requests.
 3. Connect the trigger to the send node
 4. Map the incoming chat ID to the recipient
 
-### Example 2: Send Notification to Group
+### Example 2: Send Bulk Notifications
 
 1. Use any trigger (e.g., Webhook, Schedule)
 2. Add **Chatery WhatsApp** node
-3. Select **Chat** resource and **Send Text** operation
-4. Enter your group ID and message
+3. Select **Bulk** resource and **Send Bulk Text** operation
+4. Enter comma-separated phone numbers and your message
+5. Track job status using **Get Job Status** operation
 
-### Example 3: Session Management
+### Example 3: Reply to Specific Message
+
+1. Capture the message ID from incoming webhook
+2. Use **Chat** resource with **Send Text** operation
+3. Set the `replyTo` parameter with the message ID
+
+### Example 4: Session Management
 
 1. Use **Chatery WhatsApp** node
 2. Select **Session** resource
 3. Use **Connect** to start a new session
-4. Use **QR Image** to get the QR code for scanning
-5. Use **Status** to check connection status
-
-## Development
+4. Use **Get QR Image** to get the QR code for scanning
+5. Use **Get Status** to check connection status
 
-### Build
-
-```bash
-npm run build
-```
-
-### Lint
-
-```bash
-npm run lint
-```
-
-### Run Tests
-
-```bash
-npm run test
-```
-
-## Resources
+## Links
 
+- [Chatery WhatsApp API](https://github.com/farinchan/chatery_whatsapp)
+- [Chatery Documentation](https://docs.chatery.app)
 - [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/)
-- [Chatery WhatsApp API Documentation](https://github.com/AhmadShahid/chatery)
 
 ## Author
 
-**Dajri Rinaldi Chan**
+**Fajri Rinaldi Chan** (Farin Chan)
 - Email: fajri@gariskode.com
 - GitHub: [@farinchan](https://github.com/farinchan)
 
+## Support
+
+If you find this project helpful, consider supporting the development:
+
+- [Saweria](https://saweria.co/fajrichan)
+- [PayPal](https://paypal.me/farinchan)
+
 ## License
 
 [MIT](LICENSE.md)