JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 887
  • Score
    100M100P100Q118512F
  • License MIT

n8n community nodes for Wuzapi - WhatsApp Multi-Device REST API

Package Exports

  • n8n-nodes-wuzapi
  • n8n-nodes-wuzapi/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (n8n-nodes-wuzapi) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

n8n-nodes-wuzapi

This is an n8n community node that provides a complete integration with Wuzapi - a multi-user and multi-device REST API for WhatsApp.

Wuzapi implements a robust WhatsApp Web API that allows you to send and receive messages, manage groups, handle media files, and much more through a simple REST interface.

n8n is a fair-code licensed workflow automation platform.

Table of Contents

Installation

Follow the installation guide in the n8n community nodes documentation.

Quick Installation

  1. In n8n, go to Settings > Community Nodes
  2. Click Install a community node
  3. Enter n8n-nodes-wuzapi
  4. Click Install

Manual Installation

npm install n8n-nodes-wuzapi

Operations

This package includes 10 specialized nodes, each focused on specific WhatsApp operations:

🔐 Wuzapi Credentials

Handles authentication with your Wuzapi instance.

📱 Wuzapi Session

  • Connect - Connect to WhatsApp servers
  • Disconnect - Disconnect from WhatsApp
  • Get Status - Check connection status
  • Get QR Code - Get QR code for scanning
  • Logout - Logout and terminate session
  • Pair Phone - Get pairing code for phone
  • Set Proxy - Configure proxy settings
  • Configure S3 - Set up S3 storage for media
  • Test S3 - Test S3 connection

💬 Wuzapi Message

Send various types of messages:

  • Text - Send text messages
  • Image - Send images with optional captions
  • Audio - Send audio messages
  • Video - Send videos with optional captions
  • Document - Send documents of any type
  • Sticker - Send stickers
  • Location - Send location coordinates
  • Contact - Send contact cards (vCard)
  • Template - Send template messages with buttons
  • Buttons - Send interactive button messages
  • List - Send list messages
  • Poll - Send polls to groups

🗨️ Wuzapi Chat

Manage chat interactions:

  • Delete Message - Delete sent messages
  • Edit Message - Edit previously sent messages
  • Download Media - Download media from messages
  • Mark as Read - Mark messages as read
  • React to Message - Send reactions to messages
  • Set Presence - Show typing/recording indicators

👤 Wuzapi User

User information and presence:

  • Check Users - Check if users have WhatsApp
  • Get User Info - Get detailed user information
  • Get Avatar - Get user profile pictures
  • Get Contacts - Get all contacts
  • Set Presence - Set global online/offline status

👥 Wuzapi Group

Complete group management:

  • Create - Create new groups
  • List - List all groups
  • Get Info - Get group information
  • Get Invite Link - Get group invite link
  • Join - Join group via invite
  • Leave - Leave a group
  • Set Name - Change group name
  • Set Description - Set group description
  • Set Photo - Set group photo
  • Remove Photo - Remove group photo
  • Set Announce - Enable/disable admin-only messages
  • Set Locked - Lock/unlock group info editing
  • Set Ephemeral - Configure disappearing messages
  • Update Participants - Add/remove/promote/demote members

🔗 Wuzapi Webhook

Configure webhook settings:

  • Get - Get current webhook configuration
  • Set - Configure webhook URL and events
  • Update - Update webhook settings
  • Delete - Remove webhook configuration

👨‍💼 Wuzapi Admin

Administrative operations (requires admin token):

  • List Users - List all Wuzapi users
  • Create User - Create new user with token
  • Delete User - Delete user from database
  • Delete User Full - Complete user removal (DB, S3, logout)

🔔 Wuzapi Trigger

Receive real-time WhatsApp events:

  • Events - Message, Read Receipt, Presence, History Sync, Chat Presence
  • Filters - Filter by phone, group, message type, content, etc.
  • Options - Download media, simplify output, include raw data

⏳ Wuzapi Send and Wait

Send messages and wait for responses:

  • Approval Messages - Send messages with approval buttons
  • Free Text Response - Wait for user text input via web form
  • Custom Forms - Create custom forms for user responses
  • Wait Time Limits - Set maximum wait times
  • Attribution - Optional n8n branding

Credentials

To use these nodes, you need to configure the Wuzapi credentials:

  1. API Token - Your Wuzapi user token for authentication
  2. API URL - The base URL of your Wuzapi instance
  3. Advanced Options (Optional):
    • Proxy URL - HTTP/SOCKS5 proxy for requests
    • Request Timeout - Timeout in milliseconds
    • Retry on Failure - Enable automatic retries
    • Max Retries - Maximum retry attempts

Setting up Wuzapi

  1. Install and run Wuzapi following the official documentation
  2. Create a user with an authentication token
  3. Use the token and API URL in n8n credentials

Nodes Overview

Modular Design

This package follows a modular design where each node focuses on specific functionality:

  • Session Management - Connection, authentication, and configuration
  • Messaging - All message sending operations
  • Chat Operations - Message management and interactions
  • User Operations - User information and presence
  • Group Management - Complete group functionality
  • Webhook Configuration - Event subscription management
  • Administration - User management (admin only)
  • Event Trigger - Real-time event reception
  • Send and Wait - Interactive approval workflows

Key Features

  • ✅ Complete API Coverage - All Wuzapi endpoints implemented
  • 🔄 Automatic Retry Logic - Built-in retry mechanism with exponential backoff
  • 🛡️ Robust Error Handling - Graceful error handling with detailed messages
  • 🎯 Type Safety - Full TypeScript implementation
  • 📦 Binary Data Support - Handle images, videos, documents seamlessly
  • 🔐 Multi-tenant Support - Each user has independent WhatsApp sessions
  • ☁️ S3 Integration - Optional cloud storage for media files
  • 🌐 Proxy Support - HTTP/SOCKS5 proxy configuration
  • ⚡ High Performance - Optimized for production use
  • 🎨 User-Friendly - Intuitive interface with helpful descriptions

Usage Examples

Send a Text Message

// Using Wuzapi Message node
{
  "messageType": "text",
  "phone": "5491155553934",
  "body": "Hello from n8n!"
}

Send an Image with Caption

// Using Wuzapi Message node
{
  "messageType": "image",
  "phone": "5491155553934",
  "imageSource": "binary",
  "binaryProperty": "data",
  "caption": "Check out this image!"
}

Create a Group

// Using Wuzapi Group node
{
  "operation": "create",
  "groupName": "My n8n Group",
  "participants": "5491155553934,5491155553935"
}

Set Up Webhook Trigger

// Using Wuzapi Trigger node
{
  "events": ["Message", "ReadReceipt"],
  "filters": {
    "messageType": "text",
    "isGroup": "false"
  }
}

Error Handling

All nodes include comprehensive error handling:

  • Automatic Retries - Failed requests are retried with exponential backoff
  • Continue on Fail - Option to continue workflow execution on errors
  • Detailed Error Messages - Clear error descriptions for debugging
  • HTTP Status Codes - Proper status code handling
  • Authentication Errors - No retry on authentication failures

Compatibility

  • n8n Version: 0.210.0 or higher
  • Node.js: 20.15 or higher
  • Wuzapi: Compatible with all Wuzapi versions

Resources

Support

For issues and feature requests, please use the GitHub issues page.

License

MIT

Author

Guilherme Jansen - guilherme@setupautomatizado.com.br

Made with ❤️ for the n8n community