wapizap

n8n community nodes for WapiZap WhatsApp API

Documentation

n8n-nodes-wapizap

npm version
License: MIT
n8n

Official n8n community nodes for the WapiZap WhatsApp API. Send messages, manage instances, handle groups, and automate WhatsApp workflows with ease.

Features

  • 4 Specialized Nodes: Instance, Message, Group, and Chat management
  • Modern REST API: Clean v2 endpoints for all operations
  • Zero Dependencies: Lightweight implementation using only n8n-workflow
  • Lazy Loading: Operations load on-demand for optimal performance
  • Security First: Input validation, SSRF protection, sanitization, API key masking
  • TypeScript: Fully typed with strict type checking

Installation

Via n8n Community Nodes

  1. Go to Settings > Community Nodes in your n8n instance
  2. Click Install
  3. Enter: n8n-nodes-wapizap
  4. Click Install

Via npm (for self-hosted)

npm install n8n-nodes-wapizap

Manual Installation

cd ~/.n8n/custom
npm install n8n-nodes-wapizap
# Restart n8n

Nodes Included

1. WapiZap Instance

Manage WhatsApp instances and connections.

Operations (8):

  • Create Instance
  • List Instances
  • Get Instance
  • Delete Instance
  • Connect Instance
  • Disconnect Instance
  • Get QR Code
  • Check Status

Use Cases:

  • Multi-instance management
  • Auto-reconnection workflows
  • QR code generation
  • Instance health monitoring

2. WapiZap Message

Send various types of WhatsApp messages.

Operations (16):

  • Send Text
  • Send Image
  • Send Video
  • Send Audio
  • Send Document
  • Send Sticker
  • Send Location
  • Send Contact
  • Send Poll
  • Send Buttons
  • Send List
  • Send Reaction
  • Edit Message
  • Delete Message

Use Cases:

  • Marketing campaigns
  • Customer support
  • Automated notifications
  • File sharing
  • Interactive polls and surveys

3. WapiZap Group

Manage WhatsApp groups.

Operations (11):

  • Create Group
  • List Groups
  • Get Group Info
  • Update Picture
  • Update Settings
  • Add Participants
  • Remove Participants
  • Promote Admin
  • Demote Admin
  • Get Invite Code
  • Leave Group

Use Cases:

  • Automated group creation
  • Bulk participant management
  • Admin management
  • Group moderation

4. WapiZap Chat

Manage chats and download media.

Operations (11):

  • List Chats
  • Get Messages
  • Mark as Read
  • Archive Chat
  • Check Number
  • Get Profile Picture
  • Send Presence (typing, recording)
  • Download Image
  • Download Video
  • Download Audio
  • Download Document

Use Cases:

  • Chat archival
  • Message history retrieval
  • Media backup
  • Presence simulation
  • Number validation

Authentication

  1. In n8n, go to Credentials > New
  2. Search for WapiZap API
  3. Fill in:
    • API Key: Your WapiZap API key
    • Environment: Production, Development, or Custom
    • Base URL (for Custom): Your custom API URL

Get your API key from: https://api.wapizap.com

Usage Examples

Example 1: Send a Text Message

[WapiZap Message: Send Text]
  ├─ Instance: my-instance
  ├─ To: 5511999998888
  └─ Text: "Hello! How can we help you?"

Example 2: Group Welcome Message

[n8n Webhook / Trigger]
  ├─ Receives group.participant.add event
        ↓
[WapiZap Message: Send Text]
  └─ Text: "Welcome to the group! Please read our rules."

Example 3: Media Backup

[n8n Webhook / Trigger]
  ├─ Receives message with media
        ↓
[WapiZap Chat: Download Image/Video]
        ↓
[Google Drive: Upload File]

Example 4: Instance Monitoring

[Schedule Trigger]
  ├─ Every 5 minutes
        ↓
[WapiZap Instance: Check Status]
        ↓
[IF: status !== "connected"]
        ↓
[WapiZap Instance: Connect]

Security Features

  • SSRF Protection: Block internal/localhost URLs in media downloads
  • Input Sanitization: Clean phone numbers, validate URLs
  • API Key Masking: Sensitive data redacted from logs and errors
  • No Data Leaks: Error messages sanitized
  • Output Encoding: XSS prevention on response data

Development

Build from Source

git clone https://github.com/wapizap/n8n-nodes-wapizap.git
cd n8n-nodes-wapizap
npm install
npm run build

Link Locally

npm link
cd ~/.n8n/custom
npm link n8n-nodes-wapizap
n8n start

Linting & Formatting

npm run lint          # Check linting
npm run lint:fix      # Fix linting issues
npm run format        # Format code

License

MIT License - See LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit issues and pull requests.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Support

Credits

Created and maintained by the WapiZap team.

Built for the n8n community.


Note: This is a community node. It is not officially maintained by n8n GmbH. For official n8n nodes, please visit the n8n documentation.

Discussion