whats-auto

N8N nodes for WhatsApp automation server

Package Information

Released: 15 mo ago
Downloads: 16 weeklyĀ /Ā 48 monthly
Latest Version: 2.0.0-hybrid
Author: Salmane El Idrissi

Documentation

N8N WhatsApp Automation Nodes

šŸš€ Version 2.0.0-hybrid - Enhanced with flexible connection modes!

This package provides N8N nodes for WhatsApp automation with support for both external server and embedded modes.

šŸŽÆ Key Features

  • šŸ”§ Flexible Connection Modes: Choose between external server or embedded mode
  • 🌐 External Server Mode: Full compatibility with existing WhatsApp servers
  • ⚔ Real-time Webhooks: Instant message triggers with webhook support
  • šŸ”„ Backward Compatibility: Works with existing setups
  • šŸ›”ļø Future-Ready: Foundation for embedded mode (coming soon)

šŸ“¦ Installation

Install from NPM

npm install n8n-nodes-whats-auto

Then restart your N8N instance to load the new nodes.

šŸ”§ Configuration

WhatsApp Server API Credentials

  1. Go to N8N Credentials
  2. Create new "WhatsApp Server API" credential
  3. Configure:
    • Mode: Choose "External Server" (recommended)
    • Session ID: Unique identifier for your WhatsApp session
    • Server URL: Your WhatsApp server URL (e.g., http://localhost:8000)
    • API Key: Optional API key for authentication
    • Enable Webhooks: Enable for real-time triggers

šŸ—ļø Connection Modes

External Server Mode (Recommended)

  • Use Case: Production environments, existing setups
  • Requirements: WhatsApp server running separately
  • Benefits: Stable, tested, full webhook support
  • Setup: Configure server URL and credentials

Embedded Mode (Future)

  • Use Case: Simplified deployments
  • Requirements: None (runs in N8N)
  • Status: Coming in future version
  • Current: Shows helpful message to use external mode

šŸ“± Nodes

WhatsApp Connect Node

Connects to WhatsApp and manages sessions.

Operations:

  • Connect with QR Data
  • Connect with QR Image
  • Check Session Status
  • Delete Session

WhatsApp Trigger Node

Listens for WhatsApp messages and events.

Features:

  • Real-time webhooks (external mode)
  • Multiple trigger types
  • Message filtering
  • Connection event monitoring

šŸš€ Usage

Basic Setup

  1. Setup WhatsApp Server (if using external mode)
  2. Create Credentials with your server details
  3. Add Connect Node to get QR code
  4. Add Trigger Node to listen for messages
  5. Enable Webhooks for real-time triggers

Example Workflow

1. WhatsApp Connect (Get QR Code)
2. WhatsApp Trigger (Listen for messages)
3. Process incoming messages
4. Send automated responses

šŸ”„ Migration from v1.x

This version is fully backward compatible with v1.x:

  • Existing workflows continue to work
  • All previous features maintained
  • New mode selection added
  • Enhanced webhook support

šŸ› ļø Troubleshooting

Common Issues

  1. Embedded mode not working: Use External Server mode instead
  2. Webhooks not triggering: Check server connectivity and webhook settings
  3. Session connection issues: Verify server URL and credentials

šŸ“Š What's New in v2.0.0-hybrid

  • Mode Selection: Choose between external server and embedded modes
  • Enhanced Credentials: Conditional fields based on selected mode
  • Future-Ready: Foundation for embedded mode
  • Improved Error Handling: Better error messages and guidance
  • Cleaner Dependencies: Reduced package size

šŸ”® Coming Soon

  • Full Embedded Mode: Run WhatsApp sessions directly in N8N
  • Session Sharing: Multiple workflows sharing same session
  • Advanced Filtering: More message filtering options

šŸ“„ License

MIT License

šŸ†˜ Support

For issues and questions:

  1. Check troubleshooting section
  2. Verify server connectivity
  3. Open an issue on GitHub

Note: This hybrid version provides a stable external server mode while preparing for future embedded capabilities. Use External Server mode for production environments.

Discussion