Maytapi
Maytapi n8n Integration for WhatsApp API
Official Maytapi custom nodes for n8n workflow automation platform. Automate WhatsApp messaging, manage contacts, groups, sessions, and more with visual drag-and-drop workflows. Connect WhatsApp to 400+ apps and services without writing code.
What is n8n?
n8n is a powerful open-source workflow automation platform that lets you connect different apps and services visually. Build complex automations using a drag-and-drop interface without writing code.
With Maytapi's official n8n nodes, you can integrate WhatsApp into any workflow -- send messages, manage groups, handle contacts, receive real-time webhook events, and automate your entire WhatsApp communication pipeline.
Quick Setup
Install via n8n Community Nodes or npm:
npm install @maytapi/n8n-nodes-maytapiCredentials needed:
- Product ID: From Maytapi Console
- API Token: Your x-maytapi-key
- Phone ID: (Optional) Default WhatsApp instance
How It Works
Install the Package
In n8n, go to Settings → Community Nodes → Install and enter @maytapi/n8n-nodes-maytapi. Or install manually via npm and restart n8n.
Add Credentials
Create a new Maytapi API credential with your Product ID and API Token from the Maytapi Console. Optionally set a default Phone ID.
Build Workflows
Add Maytapi or Maytapi Trigger nodes to your workflows and connect them with 400+ other apps and services in n8n.
Two Powerful Nodes
The package includes two dedicated nodes covering the full Maytapi WhatsApp API.
Maytapi Node (Actions)
Perform WhatsApp operations in your workflows. Supports 9 resource categories with 50+ operations:
- Message: Send 23+ message types (text, media, poll, location, vcard, buttons, list, sticker, reaction, forward, delete, edit, and more)
- Contact: Get contacts, check phone numbers, block/unblock, profile images
- Chat: List conversations, archive, pin, mute, favorite, clear history
- Group: Create groups, manage members, admins, settings, invites, join requests
- Queue: List, get, and clear message queues
- Call: Reject calls, create voice/video call links
- Account: Manage phones, webhooks, logs, product info
- Session: Check status, get QR code, logout, connect with phone number
- Session Control: Redeploy, factory reset, get/set config
Maytapi Trigger Node (Webhooks)
Receive real-time WhatsApp events to trigger your workflows. Select which events to listen for:
- Message Events: New incoming/outgoing messages with full metadata (type, subtype, sender, text, media, timestamp)
- ACK Events: Message delivery status changes (sent, delivered, read)
- Group Events: Member joins, leaves, invites, removals, setting changes
- Call Events: Incoming, outgoing, missed, rejected calls
- Story Events: New stories posted by contacts
Webhooks are automatically configured when you activate the workflow and cleaned up when you deactivate it.
Available Operations
Complete list of operations available in the Maytapi Node, grouped by resource.
Message Operations
| Operation | Description |
|---|---|
Send Message | Send messages to any chat. Supports 23+ message types: text, media, poll, location, vcard, contact, link, product, buttons, list, sticker, short video, forward, delete, reaction, unreact, edit, group invite, pin message, star, create event, story text reply, and story media reply. |
Get Message | Retrieve information about a specific message by ID |
Get Messages | Retrieve messages from a conversation with pagination, author filter, and fromMe filter |
Contact Operations
| Operation | Description |
|---|---|
Get Contacts | List all WhatsApp contacts |
Get Contact | Get specific contact information |
Check Phones | Check if phone numbers are registered on WhatsApp |
Block Contact | Block or unblock a contact |
Get Profile Image | Get profile picture of a contact or group |
Set Profile Image | Set your WhatsApp account profile picture |
Chat Operations
| Operation | Description |
|---|---|
Get Conversations | List all conversations/chats with pagination |
Get Conversation | Get specific conversation details with messages |
Favorite Chat | Add or remove a conversation from favorites |
Pin Chat | Pin or unpin a conversation |
Archive Chat | Archive or unarchive a conversation |
Mute Chat | Mute or unmute a conversation (8 hours, 1 week, or forever) |
Clear Chat | Clear all messages from a conversation |
Group Operations
| Operation | Description |
|---|---|
Create Group | Create a new WhatsApp group with participants, optional invite message and profile image |
Get Groups | List all groups with optional participant loading, sorting, invite links, and pagination |
Get Group | Get specific group info with optional invite link generation |
Set Group Image | Set group profile picture |
Delete Group Image | Delete group profile picture |
Add Participants | Add members to a group with optional invitation |
Remove Participant | Remove a member from a group |
Promote Admin | Promote a participant to admin |
Demote Admin | Demote an admin to participant |
Set Group Config | Configure group settings: permissions, disappearing messages, member addition approval, name, description |
Accept Invite | Accept a group invitation by invite code |
Revoke Invite | Revoke and regenerate group invite link |
Leave Group | Leave a WhatsApp group |
Get Approval Requests | List pending join requests for a group |
Approve Join Requests | Approve pending join requests |
Reject Join Requests | Reject pending join requests |
Get Group Info by Invite Code | Get group info using invite code |
Queue Operations
| Operation | Description |
|---|---|
List Queues | List all phone message queues |
Get Queue | Get message queue for a specific phone |
Clear Queue | Clear phone message queue |
Call Operations
| Operation | Description |
|---|---|
Reject Call | Reject an incoming call (callId obtained from webhook notification) |
Create Call Link | Create a shareable call link for voice or video calls with scheduled timestamp |
Account Operations
| Operation | Description |
|---|---|
Get Product Info | Get product information |
Add Phone | Add a new phone to the product with optional phone number |
List Phones | List all registered phones |
Set Webhook | Configure webhook URL for the product |
Set ACK Preference | Enable or disable acknowledgment notifications via webhook |
Get Logs | Get logs for all phones |
Get Phone Logs | Get logs for a specific phone |
Session Operations
| Operation | Description |
|---|---|
Get Status | Check connection status of the session |
Get Screen | Get screenshot of the current session screen (returns binary image) |
Get QR Code | Get QR code for phone pairing (returns binary image) |
Logout | Disconnect WhatsApp session |
Connect with Phone Number | Connect using phone number instead of QR code |
Session Control Operations
| Operation | Description |
|---|---|
Redeploy | Redeploy Docker instance to reboot the session |
Factory Reset | Factory reset phone to initial state |
Get Config | Get phone-specific configuration |
Set Config | Set phone-specific webhook URL and ACK delivery settings |
Webhook Trigger Events
| Event Type | Description |
|---|---|
Message | New incoming/outgoing messages with full metadata: message type, subtype, sender number, sender name, receiver, message text, message ID, timestamp, conversation details |
ACK | Message delivery status changes: sent, delivered, read -- with message ID and timestamp |
Group | Group member events: joins, leaves, invites, removals, setting changes -- with group ID, name, action type, and participant details |
Call | Call events: incoming, outgoing, missed, rejected calls -- with call ID, status, and caller details |
Story | Story events: new stories posted by contacts -- with story ID, sender, story type, and content |
Why Use Maytapi n8n Nodes?
Bring the full power of WhatsApp API into your n8n workflows with purpose-built nodes.
- Full API coverage with 50+ operations across 9 resource categories
- Real-time webhook triggers for messages, delivery status, group events, calls, and stories
- No coding required -- visual drag-and-drop workflow builder
- Phone ID flexibility -- use default or custom phone per operation
- Built-in error handling with retry logic and detailed error messages
- Connect WhatsApp to 400+ apps: CRMs, databases, email, Slack, and more
Automate your WhatsApp communication with the tools you already use.
Technical Details
Package Name:
@maytapi/n8n-nodes-maytapi
API Endpoint:
https://api.maytapi.com/api/{pid}
Authentication:
- Header:
x-maytapi-key - Product ID in URL path
- Optional Phone ID parameter per operation
Resources:
Message, Contact, Chat, Group, Queue, Call, Account, Session, Session Control
Ready to Supercharge Your WhatsApp Communication?
Unlock powerful features for business messaging and automation with our WhatsApp API
Perfect for businesses, developers, and power users
Frequently Asked Questions
How do I install the Maytapi n8n nodes?
Go to Settings → Community Nodes → Install in your n8n instance and search for @maytapi/n8n-nodes-maytapi. Or install manually via npm: npm install @maytapi/n8n-nodes-maytapi and restart n8n.
What credentials do I need?
You need your Product ID and API Token from the Maytapi Console. Optionally, you can specify a default Phone ID for your WhatsApp instance.
Can I use multiple WhatsApp numbers?
Yes! You can set a default Phone ID in credentials or override it per node. The "Phone ID Source" option lets you choose between credentials or custom Phone ID for each operation.
How do webhooks work with n8n?
The Maytapi Trigger node automatically configures webhooks with Maytapi when you activate the workflow. You can select which events to receive (messages, ACK, groups, calls, stories). The webhook is automatically cleaned up when you deactivate the workflow.
What message types can I send?
The Send Message operation supports all Maytapi message types: text, images, videos, documents, audio, location, contact cards, stickers, polls, reactions, buttons, list messages, short video, forward, delete, edit, pin, and more.
Is the n8n integration free?
The Maytapi n8n nodes package is free and open source. You only need an active Maytapi subscription to use the WhatsApp API. All Maytapi plans include full API access with no extra fees for n8n integration.