n8n-nodes-maytapi

This is an n8n community node enabling integration of the Maytapi WhatsApp Unofficial API into your n8n workflows.

Maytapi is a WhatsApp Unofficial API that provides comprehensive messaging and management functionality through REST endpoints.

n8n is a fair-code licensed workflow automation platform.

Installation
Operations
Credentials
Usage
Resources

Installation

Follow the installation guide in the n8n community nodes documentation.

1. Go to Settings > Community Nodes.
2. Select Install.
3. Enter @maytapi/n8n-nodes-maytapi in Enter npm package name.
4. Agree to the risks of using community nodes: select I understand the risks of installing unverified code from a public source.
5. Select Install.

After installing the node, you can use it like any other node. n8n displays the node in search results in the Nodes panel.

Operations

Actions

Message

• Send Message (Text, Media, Poll, vCard, Contact, Location, Link, Product, Buttons, List, Sticker, Short Video, Forward, Delete, Reaction, Edit, Group Invite, Pin Message, Star Message, Unreaction, Event, Story Text Reply, Story Media Reply, Reply Message)
• Get Message
• Get Messages

Contact

• Get all contacts
• Get specific contact
• Check phone numbers
• Block/unblock contact
• Get profile image
• Set profile image

Chat

• Get Conversations
• Get Conversation
• Favorite Chat
• Pin Chat
• Archive Chat
• Mute Chat
• Clear Chat

Group

• Create Group
• Get Groups
• Get Group
• Set Group Image
• Add Participants
• Remove Participant
• Promote Admin
• Demote Admin
• Leave Group
• Revoke Invite
• Delete Profile Image
• Set Group Config
• Accept invite
• Accept inviteV4
• Get approval requests
• Approve join requests
• Reject join requests
• Get group info by invite code

Queue

• List All Queues
• Get Queue
• Clear Queue

Account

• Get Product Info
• Add Phone
• List Phones
• Set Webhook
• Set Ack Preference
• Get Logs (All Phones)
• Get Logs (Specific Phone)

Session

• Get Status
• Get Screen
• Get QR Code
• Logout
• Connect with phone number

Session Control

• Redeploy
• Factory Reset
• Get Config
• Set Config

Call

• Reject an incoming call
• Create Call Link

Triggers

Maytapi Trigger

• Message Events (new messages received)
• Message Status (ACK) (delivery status: sent, delivered, read)
• Group Member Events (promote, demote, add, remove, invite, leave, modify, name, description, restrict, announce, member_add_mode, membership_approval_mode)
• Call Events (miss, reject, accept, ringing)
• Story Events (received messages for stories in chats)

Credentials

Configure the Maytapi API credentials as follows:

1. Go to your Maytapi Console
2. Copy your Product ID and API Token
3. In n8n, create a new Maytapi API credential
4. Enter your Product ID and Token
5. Enter your Phone ID (your default WhatsApp instance number from Maytapi console)

Usage

Sending a Text Message

1. Incorporate a Maytapi node into your workflow
2. Select Resource: Message
3. Select Operation: Send Message
4. Configure your credentials
5. Choose Phone ID Source: From Credentials or Custom
6. Enter To Phone Number (recipient's number)
7. Select Message Type: Text
8. Enter your Message Text

Setting up Webhook Triggers

1. Add a Maytapi Trigger node to your workflow
2. Configure your credentials (with Phone ID included)
3. Select the Events you want to listen to
4. Copy the webhook URL from n8n workflow
5. Configure webhook in Maytapi Console
6. Activate the workflow

The webhook will automatically receive events in real-time.