N8N Tools - WAHA API

Complete WhatsApp automation with WAHA API - Multi-engine support with 5-minute setup.

Features

• Multi-Engine Support: WEBJS, NOWEB, VENOM engines for different use cases
• Session Management: Start, stop, restart sessions with QR code authentication
• Message Operations: Text, media, voice, video, location with reactions and replies
• Chat Management: Archive, pin, clear messages, delete chats
• Contact Operations: Get contacts, check existence, profile photos, block/unblock
• Group Management: Create, manage participants, settings, invite codes
• Webhook Integration: Real-time event notifications
• Media Handling: Send/receive images, videos, audio, documents with metadata

Installation

npm install n8n-nodes-n8ntools-waha-api

Credentials

Configure WAHA API credentials in N8N:

1. Base URL: Your WAHA server URL (e.g., http://localhost:3000)
2. API Key: Optional API key if authentication is enabled
3. Default Session: Default session name to use (e.g., default)

Operations

Session Operations

• Start Session: Initialize WhatsApp session with engine selection
• Stop Session: Stop running session
• Restart Session: Restart existing session
• Get Sessions: List all active sessions
• Get Session: Specific session information
• Get QR Code: QR code for device authentication
• Get Screenshot: Session browser screenshot
• Logout Session: Logout and clear session data

Message Operations

• Send Text: Text messages with formatting
• Send Image: Image files with captions
• Send File: Documents with custom filenames
• Send Voice: Audio messages and voice notes
• Send Video: Video files with captions
• Send Location: GPS coordinates
• Send Link Preview: URLs with custom previews
• Send Contact: vCard contact sharing
• Message Actions: Read receipts, typing indicators
• Message Reactions: Emoji reactions to messages
• Reply/Forward/Edit: Message interaction features
• Delete Message: Remove sent messages

Chat Operations

• Get Chats: List all conversations
• Get Messages: Message history with media download
• Delete Chat: Remove entire conversations
• Clear Messages: Clear chat history
• Archive/Unarchive: Chat organization
• Pin/Unpin: Important chat management

Contact Operations

• Get Contacts: All WhatsApp contacts
• Get Contact: Specific contact details
• Get Contact About: Status/about information
• Get Contact Photo: Profile picture URLs
• Block/Unblock Contact: Contact management
• Check Number Exists: Verify WhatsApp presence

Group Operations

• Create Group: New group creation
• Get Group: Group information and metadata
• Leave Group: Exit group conversations
• Set Group Description: Update group description
• Set Group Subject: Change group name
• Group Invite Codes: Generate and revoke codes
• Participant Management: Add, remove, promote, demote members
• Get Participants: List all group members

Webhook Operations

• Set Webhook: Configure event notification URL
• Get Webhook: Current webhook configuration

Status Operations

• Get Version: WAHA version information
• Health Check: System health status

Usage Examples

Start Session with Engine

{
  "resource": "session",
  "operation": "startSession",
  "sessionName": "my-session",
  "engine": "WEBJS"
}

Send Text Message

{
  "resource": "message",
  "operation": "sendText",
  "sessionName": "my-session",
  "chatId": "5511999999999@c.us",
  "text": "Hello from WAHA!"
}

Send Image with Caption

{
  "resource": "message",
  "operation": "sendImage",
  "sessionName": "my-session",
  "chatId": "5511999999999@c.us",
  "fileUrl": "https://example.com/image.jpg",
  "caption": "Check this out!"
}

Create Group

{
  "resource": "group",
  "operation": "createGroup",
  "sessionName": "my-session",
  "groupName": "My Group",
  "participants": "5511999999999@c.us,5511888888888@c.us"
}

Engine Comparison

• WEBJS: Most stable, browser-based, full WhatsApp Web features
• NOWEB: Multi-device API, no browser required, faster startup
• VENOM: Alternative engine with additional features

Authentication

WAHA supports optional API key authentication. When enabled, include the X-Api-Key header for all requests.

Webhook Events

WAHA provides real-time events for:

• message: New messages received
• message.reaction: Message reactions
• session.status: Connection status changes
• group.participant: Group member changes

Support

• Documentation: WAHA Docs
• Issues: GitHub Issues