New Message WhatsApp usernames directly: sendMessage now accepts @username as the recipient. See what's new →
Integrations

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-maytapi

Credentials needed:

  • Product ID: From Maytapi Console
  • API Token: Your x-maytapi-key
  • Phone ID: (Optional) Default WhatsApp instance

How It Works

1
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.

2
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.

3
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 14 resource categories with 138 operations:

  • Message: Send 38 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
  • Label: Create, edit and delete labels, tag and untag chats
  • Presence: Read and send online, typing and recording status
  • Business Catalog: Products, collections, orders and business profile
  • Group: Create groups, manage members, admins, settings, invites, join requests
  • Community: Create communities, manage members, admins and sub-groups
  • Channel: Create channels, post, search, follow and read statistics
  • Story: Post stories, read viewers and manage story privacy
  • 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 MessageSend messages to any chat. Supports 38 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 MessageRetrieve information about a specific message by ID
Get MessagesRetrieve messages from a conversation with pagination, author filter, and fromMe filter

Contact Operations

Operation Description
Get ContactsList all WhatsApp contacts
Get ContactGet specific contact information
Check PhonesCheck if phone numbers are registered on WhatsApp
Block ContactBlock or unblock a contact
Get Profile ImageGet profile picture of a contact or group
Set Profile ImageSet your WhatsApp account profile picture
Delete Profile ImageDelete your WhatsApp account profile picture
Get Blocked ContactsList blocked contacts
Add ContactAdd a contact to the phone address book
Edit ContactEdit a saved contact
Remove ContactRemove a contact from the address book
LID to PhoneResolve a @lid identifier to a phone number
Phone to LIDResolve a phone number to its @lid identifier
Phone to UsernameGet the WhatsApp username of a phone number
Username to PhoneResolve a WhatsApp username to a phone number
Get Profile NameGet the profile (display) name of your number
Set Profile NameChange the profile (display) name of your number
Get Profile AboutGet the "About" text of your number or a contact
Set Profile AboutSet the "About" text of your number
Get Profile UsernameGet the WhatsApp username of your number
Set Profile UsernameSet the WhatsApp username of your number

Chat Operations

Operation Description
Get ConversationsList all conversations/chats with pagination
Get ConversationGet specific conversation details with messages
Favorite ChatAdd or remove a conversation from favorites
Pin ChatPin or unpin a conversation
Archive ChatArchive or unarchive a conversation
Mute ChatMute or unmute a conversation (8 hours, 1 week, or forever)
Clear ChatClear all messages from a conversation
Set Disappearing MessagesSet the disappearing messages timer of a conversation (off, 24h, 7 days, 90 days)

Label Operations

Operation Description
Get LabelsList all labels of the number
Get Labeled ChatsList the chats carrying a label
Get Label ColorsList the available label colors
Create LabelCreate a new label
Edit LabelRename a label or change its color
Delete LabelsDelete labels from the WhatsApp account
Add Label to ChatAdd a label to a chat
Remove Label from ChatRemove a label from a chat

Presence Operations

Operation Description
Get PresenceGet the online/typing state of a contact
Subscribe PresenceSubscribe to presence updates of a contact
Send PresenceSend typing, recording or online status to a chat

Business Catalog Operations

Operation Description
Get ProductsList catalog products of your number or a contact
Get ProductGet a single product by ID
Add ProductAdd a product to the catalog
Edit ProductEdit a catalog product
Remove ProductRemove a product from the catalog
Add Product ImageAdd an image to a product
Remove Product ImageRemove an image from a product
Get CollectionsList product collections
Get CollectionGet a collection with its products
Add CollectionCreate a product collection
Edit CollectionRename or update a collection
Remove CollectionDelete a collection
Add Collection ProductsAdd products to a collection
Remove Collection ProductsRemove products from a collection
Get OrdersList orders received while the session is running
Get OrderGet an order with its items
Get Business ProfileGet the business profile of your number or a contact
Set Business ProfileUpdate the business profile of your number

Group Operations

Operation Description
Create GroupCreate a new WhatsApp group with participants, optional invite message and profile image
Get GroupsList all groups with optional participant loading, sorting, invite links, and pagination
Get GroupGet specific group info with optional invite link generation
Set Group ImageSet group profile picture
Delete Group ImageDelete group profile picture
Add ParticipantsAdd members to a group with optional invitation
Remove ParticipantRemove a member from a group
Promote AdminPromote a participant to admin
Demote AdminDemote an admin to participant
Set Group ConfigConfigure group settings: permissions, disappearing messages, member addition approval, name, description
Accept InviteAccept a group invitation by invite code
Revoke InviteRevoke and regenerate group invite link
Leave GroupLeave a WhatsApp group
Get Approval RequestsList pending join requests for a group
Approve Join RequestsApprove pending join requests
Reject Join RequestsReject pending join requests
Get Group Info by Invite CodeGet group info using invite code
Accept Invite V4Accept a group invitation (V4) received through the webhook

Community Operations

Operation Description
Create CommunityCreate a new community
Get CommunitiesList all communities with their sub-groups
Get CommunityGet a single community
Add ParticipantsAdd members to a community
Remove ParticipantRemove a member from a community
Promote AdminPromote a member to community admin
Demote AdminDemote a community admin
Add Sub-GroupsLink existing groups to a community
Remove Sub-GroupsUnlink groups from a community
Revoke InviteRevoke and regenerate the community invite link
Get Unjoined Sub-GroupsList sub-groups you have not joined yet
Join Sub-GroupJoin a sub-group of a community
Deactivate CommunityDeactivate a community (irreversible)

Channel Operations

Operation Description
Create ChannelCreate a new channel
Get ChannelsList the channels you own or follow
Get ChannelGet a single channel
Delete ChannelDelete a channel you own
Set Channel ConfigUpdate channel name, description or image
Get Invite CodeGet the invite link of a channel
Search by CountryDiscover channels by country code
Search by TextSearch channels by text
Get Channel MessagesRead the messages of a channel
SubscribeFollow a channel
UnsubscribeUnfollow a channel
Subscribe by Invite CodeFollow a channel using its invite code
Unsubscribe by Invite CodeUnfollow a channel using its invite code
Get Info by Invite CodeGet channel info from an invite code
Get StatisticsGet follower and reach statistics of a channel
Demote AdminRemove admin rights from a channel admin
Accept Admin InviteAccept an invitation to become channel admin
Revoke Admin InviteRevoke a pending channel admin invitation

Story Operations

Operation Description
Create StoryPost a text, media or audio story
Get My StoriesList your stories with their viewers
Get Contacts StoriesList the stories posted by your contacts
Get Story PrivacyGet who can see your stories
Set Story PrivacySet who can see your stories

Queue Operations

Operation Description
List QueuesList all phone message queues
Get QueueGet message queue for a specific phone
Clear QueueClear phone message queue

Call Operations

Operation Description
Reject CallReject an incoming call (callId obtained from webhook notification)
Create Call LinkCreate a shareable call link for voice or video calls with scheduled timestamp
Get CallsList the call history
Get CallGet a single call by its ID
Start CallStart an outgoing attention call that rings and ends automatically (no audio)

Account Operations

Operation Description
Get Product InfoGet product information
Add PhoneAdd a new phone to the product with optional phone number
List PhonesList all registered phones
Set WebhookConfigure webhook URL for the product
Set ACK PreferenceEnable or disable acknowledgment notifications via webhook
Get LogsGet logs for all phones
Get Phone LogsGet logs for a specific phone

Session Operations

Operation Description
Get StatusCheck connection status of the session
Get ScreenGet screenshot of the current session screen (returns binary image)
Get QR CodeGet QR code for phone pairing (returns binary image)
LogoutDisconnect WhatsApp session
Connect with Phone NumberConnect using phone number instead of QR code
Get New Chat LimitGet the new-chat limit WhatsApp applies to the number

Session Control Operations

Operation Description
RedeployRedeploy Docker instance to reboot the session
Factory ResetFactory reset phone to initial state
Get ConfigGet phone-specific configuration
Set ConfigSet phone-specific webhook URL and ACK delivery settings

Webhook Trigger Events

Event Type Description
MessageNew incoming/outgoing messages with full metadata: message type, subtype, sender number, sender name, receiver, message text, message ID, timestamp, conversation details
ACKMessage delivery status changes: sent, delivered, read -- with message ID and timestamp
GroupGroup member events: joins, leaves, invites, removals, setting changes -- with group ID, name, action type, and participant details
CallCall events: incoming, outgoing, missed, rejected calls -- with call ID, status, and caller details
StoryStory 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 138 operations across 14 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, Label, Presence, Business Catalog, Group, Community, Channel, Story, 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.