fzap

n8n nodes for FZAP WhatsApp API

Package Information

Released: 2 mo ago
Downloads: 2,167 weekly / 2,344 monthly
Latest Version: 0.2.0

Documentation

n8n-nodes-fzap

This is an n8n community node that integrates with FZAP WhatsApp API in your n8n workflows.

FZAP is a WhatsApp API service that allows you to send and receive messages, manage groups, handle media files, and more through a simple REST API.

n8n is a fair-code licensed workflow automation platform.

Installation

Follow the installation guide in the n8n community nodes documentation.

Local Testing

Run n8n with this package mounted as a custom extension:

npm run build
docker compose up -d   # n8n on http://localhost:5678

The node appears in the palette as FZAP. Rebuild and docker compose restart n8n to pick up changes.

Operations

Chat

  • Send text, image, audio, document, video, sticker messages
  • Send buttons, lists, templates, contacts, locations, polls
  • Reply to buttons and list messages
  • Download media (image, audio, document, video)
  • Edit, delete, forward, star and pin messages
  • React to messages
  • Archive, mute, pin chats; mark read or unread
  • Set chat presence (typing, recording, etc.)
  • Browse stored history: conversations, messages, search, export to CSV
  • Manage local labels and native WhatsApp labels, on chats and messages
  • Manage sticker library and Cloud API templates

Session

  • Connect/disconnect WhatsApp
  • Get QR code for authentication
  • Pair phone number
  • Get connection status
  • Configure call rejection
  • Configure S3 storage
  • Configure proxy

Group

  • Create groups
  • Get group info and invite links
  • Add/remove/promote/demote participants
  • Set group name, photo, topic
  • Configure group settings (announce, locked, ephemeral)
  • Require admin approval to join; list and approve/reject pending requests

Community

  • Create and update communities (personal WhatsApp accounts only)
  • List communities, subgroups and linked participants
  • Link/unlink groups to a community
  • Leave a community

User

  • Check if numbers are on WhatsApp
  • Get user info and avatar
  • Get/set privacy settings
  • Set profile name, status and avatar
  • Manage contacts; block and unblock
  • Resolve LID mappings

Webhook (Trigger)

  • Receive real-time events from WhatsApp
  • Message received/sent/updated
  • Connection status changes
  • Group events
  • Call events
  • And more...

Newsletter (Channels)

  • Create, update, delete and mute channels
  • Follow/unfollow, react to published messages
  • Publish text, image, video, document, audio and stickers
  • Read published messages with their view and reaction counts

Paid Traffic

  • Leads: list, export, get, enrich, journey and conversion history
  • Contacts deduplicated across leads
  • Configurable funnel stages
  • Redirect tracking campaigns and click events
  • Meta Conversions API: send conversions and test the connection

Integrations

  • Chatwoot integration
  • Status/Stories
  • Folder-scoped instance management

Credentials

To use this node, you need a running FZAP instance and a credential in n8n with:

  • Base URL: your FZAP API URL (e.g. https://api.yourfzap.com)
  • Authentication: Instance Token or Admin Token
  • Token: the instance token, when authenticating as an instance
  • Admin Token: the admin token, when authenticating as admin

With Admin Token, each node also asks which instance to act on, and the
Access Mode field on the node must match the credential type.

Compatibility

  • Tested with n8n 1.x and 2.x
  • Requires FZAP API

Some operations depend on the instance type. Chat history, labels and
conversations are served only by whatsmeow (QR code) instances; a Cloud API
instance answers those with 501.

Resources

Author

Daniel Carbonell (flouds.com.br)

Discussion