z-api

n8n node for Z-API integration

Package Information

Released: 11/4/2025
Downloads: 15 weekly / 43 monthly
Latest Version: 1.2.2
Author: Jaime Neto

Documentation

n8n-nodes-z-api

This is an n8n community node that allows you to use Z-API in your n8n workflows.

Z-API is a WhatsApp API service that enables you to send and receive messages programmatically.

n8n is a fair-code licensed workflow automation platform.

Installation

Follow the installation guide in the n8n community nodes documentation.

Credentials

To use this node, you need to configure the following credentials:

  • Instance ID: Your Z-API instance ID
  • Instance Token: Your Z-API instance token
  • Client Token: Your Z-API client token for header authentication

Resources

This node provides the following resources:

Mensagem (Message)

  • Send Text
  • Send Image
  • Send Video
  • Send Audio
  • Send Document
  • Send Poll
  • Send Contact
  • Send List
  • Send Buttons
  • React to Message

Instância (Instance)

  • Get QR Code
  • Restart Instance
  • Disconnect
  • Get Status
  • Get Phone Data

Grupo (Group)

  • Create Group
  • Update Group Info
  • Add/Remove Participants
  • Get Group Metadata
  • Leave Group

Chat

  • Get Chats
  • Read Messages
  • Archive Chat
  • Delete Chat
  • Mark as Unread

Perfil (Profile)

  • Update Profile Picture
  • Update Profile Name
  • Update Profile Status
  • Get Profile Data

Evento (Event)

  • Configure Webhook
  • Get Webhook Status
  • Update Webhook Settings

Compatibility

Tested with n8n v1.54.4 and Z-API v2.2.0+

Usage

After installation, you can find the Z-API node in your n8n editor under the Communication category.

Author

Created by @jaimeflneto

License

MIT

Discussion