Installation
- Community Nodes (Recommended)
- Manual Installation
1
Open n8n settings
Navigate to Settings → Community Nodes in your n8n instance.
2
Install the node
Click Install Community Node and enter:
3
Start using
The WSAPI node is now available in your workflow editor.
Available resources
This node covers WhatsApp operations, not Cloud Account/subscription management or OSS admin endpoints. Configure a custom base URL for a self-hosted OSS instance.
The package is published on npm; installation on n8n Cloud additionally depends on n8n’s community-node availability and policies. A published npm package does not by itself establish verified-node status.
AI agent integration
The WSAPI node works with n8n’s AI Agent nodes. Set parameters to “Let the model define this parameter” and connect directly to AI nodes for conversational workflows.Webhook trigger
The WSAPI Trigger node receives real-time events from your WhatsApp instance:- Message events (new, read, delete)
- Chat events (presence, settings)
- Session events (login, logout)
- Call events
- Contact events
- User events
adReferral metadata, including ctwaClid.
Credentials are optional for unsigned event reception. Configure the instance’s signing secret in WSAPI credentials to validate X-Webhook-Signature over the original request bytes; missing or invalid signatures return HTTP 401. API credentials are needed for automatic media download. A failure to load configured credentials is not treated as an unsigned webhook.
The Star Message operation can also unstar via its Starred switch. Message editing accepts mentions and ephemeral expiration, including off. Community creation exposes approval mode and subgroup creation accepts participants.
Common workflows
- Customer support automation — auto-respond to common queries using AI
- Order notifications — send WhatsApp updates when order status changes
- Group management bots — automate group administration tasks
- Media processing pipelines — receive and process media from WhatsApp