n8n-nodes-chatery-whatsapp

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.

n8n is a fair-code licensed workflow automation platform.

Table of Contents

• Installation
• Credentials
• Nodes
  • Chatery WhatsApp Trigger
  • Chatery WhatsApp
• Resources & Operations
• Compatibility
• Usage Examples
• License

Installation

Follow the installation guide in the n8n community nodes documentation.

npm Installation

npm install n8n-nodes-chatery-whatsapp

Manual Installation

1. Go to Settings > Community Nodes
2. Select Install
3. Enter n8n-nodes-chatery-whatsapp in the Enter npm package name field
4. Agree to the risks of using community nodes
5. Click Install

Credentials

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)

Nodes

This package includes two nodes:

Chatery WhatsApp Trigger

A webhook trigger node that listens for WhatsApp events from the Chatery API.

Supported Events:

Event	Description
all	Listen to all events
qr	QR code generated for authentication
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
• Chat ID Filter: Filter events by specific chat ID
• Ignore Status: Ignore status/story updates
• Only From Me: Only receive messages sent by you
• Only From Others: Only receive messages from others

Chatery WhatsApp

The main node for performing WhatsApp operations via HTTP requests.

Resources & Operations

Chat Resource

Operation	Description
Send Text	Send a text message (supports replyTo and mentions)
Send Image	Send an image with optional caption (supports replyTo)
Send Video	Send a video or animated GIF with optional caption (supports replyTo)
Send Audio	Send an audio or voice note (OGG format with Opus, supports replyTo)
Send Document	Send a document/file (supports replyTo)
Send Sticker	Send a sticker (WebP or image, 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 Poll	Send an interactive poll message (supports single/multiple choice)
Send Reaction	Send an emoji reaction to a message (or remove reaction)
Delete Message	Delete (revoke) a message for everyone
Pin Message	Pin a message in a chat (24h, 7d, 30d)
Star Message	Star or unstar a message
Pin Chat	Pin or unpin a chat in chat list
Archive Chat	Archive or unarchive a chat
Mute Chat	Mute or unmute notifications for a chat
Send Presence Update	Update presence status (composing, recording, available, etc.)
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

Contact Resource (NEW!)

Manage WhatsApp contacts and view profile details.

Operation	Description
Add or Update	Add or update a contact in address book (supports syncing to primary phone)
Get Status / About	Get contact status/bio/about text
Get Business Profile	Get WhatsApp Business profile (description, email, website, etc.)
Block or Unblock	Block or unblock a contact
Get Blocklist	Get list of all blocked contacts
Check Number	Check if a phone number is registered on WhatsApp
Get Profile Picture	Get profile picture URL of a contact
Get Contact Info	Get contact information

Label Resource (NEW!)

Manage WhatsApp Business labels and tag chats.

Operation	Description
Get All	Get all WhatsApp Business labels
Create	Create a new label or update an existing label
Delete	Delete a label
Add Label to Chat	Assign a label to a specific chat
Remove Label From Chat	Remove a label from a specific chat
Get Chat Labels	Get all labels assigned to a chat

Bulk Resource

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

Session Resource

Operation	Description
List	List all available sessions
Connect	Connect/start a new session
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
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
Update Profile Name	Update WhatsApp account display name
Update Profile Status	Update WhatsApp account status / bio text

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

Group Resource

Operation	Description
List	List all groups you're a member of
Create	Create a new group
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 Picture	Update group picture
Leave	Leave a group
Get Invite Code	Get group invite code
Revoke Invite	Revoke and generate new invite code
Get Invite Info	Preview group information from invite code before joining
Update Settings	Set who can send messages or edit group info
Join	Join a group using invite code

Compatibility

• n8n version: 0.5.0 or later
• Node.js: 18.10 or later

Usage Examples

Example 1: Auto-reply to Messages

1. Add Chatery WhatsApp Trigger node with message event
2. Add Chatery WhatsApp node with Send Text operation
3. Connect the trigger to the send node
4. Map the incoming chat ID to the recipient

Example 2: Send Bulk Notifications

1. Use any trigger (e.g., Webhook, Schedule)
2. Add Chatery WhatsApp node
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: 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

Build

npm run build

Lint

npm run lint

Run Tests

npm run test

Resources

• n8n community nodes documentation
• Chatery WhatsApp API
• Chatery Documentation

Author

Fajri Rinaldi Chan (Farin Chan)

• Email: fajri@gariskode.com
• GitHub: @farinchan

Support

If you find this project helpful, consider supporting the development:

• Saweria

License

MIT