n8n-nodes-messaging-gateway
v0.2.4
Published
n8n community nodes for Unified Messaging Gateway — send and receive messages across WhatsApp, Telegram, Email, and SMS
Maintainers
Readme
n8n-nodes-messaging-gateway
Community nodes for n8n to integrate with Unified Messaging Gateway — send and receive messages across WhatsApp, Telegram, Email, and SMS from your n8n workflows.
Installation
In n8n Desktop / Self-hosted
- Go to Settings > Community Nodes
- Enter
n8n-nodes-messaging-gateway - Click Install
Manual
cd ~/.n8n
npm install n8n-nodes-messaging-gatewayThen restart n8n.
Configuration
- In n8n, go to Credentials > New Credential
- Search for Messaging Gateway API
- Enter:
- Base URL: The URL of your Messaging Gateway instance (e.g.,
http://localhost:3123) - API Key: Your gateway API key
- Base URL: The URL of your Messaging Gateway instance (e.g.,
Nodes
Messaging Gateway (Action Node)
Perform operations against the Messaging Gateway API.
| Resource | Operation | Description | |----------|-------------|-----------------------------------------| | Message | Send | Send text, image, video, document, or location messages | | Message | Get Status | Retrieve the delivery status of a sent message | | Account | List | List all configured messaging accounts | | Account | Get | Get details for a specific account | | Account | Connect | Start a session / generate QR code | | Account | Disconnect | Stop an active session | | Group | List | List groups for an account | | Group | Get | Get detailed group information | | Webhook | List | List registered webhooks | | Webhook | Add | Register a new webhook endpoint | | Webhook | Remove | Delete a webhook by ID |
Messaging Gateway Trigger (Trigger Node)
Starts a workflow when the gateway receives an inbound message or event.
- Add the Message Received trigger to your workflow
- Activate the workflow to obtain the webhook URL
- Register that URL in your Messaging Gateway via the Webhook > Add operation or the gateway API
- Incoming messages will trigger the workflow with the full
UnifiedEnvelopepayload
Supported events:
message.inbound— New incoming messagemessage.status— Delivery status update (sent, delivered, read, failed)connection.update— Account connection state change
Example Workflows
Auto-reply to WhatsApp messages
- Message Received trigger (events:
message.inbound) - IF node to check
{{$json.content.type}} === 'text' - Messaging Gateway Send node to reply with a text message
Forward Telegram messages to Slack
- Message Received trigger (events:
message.inbound) - Slack node to post the message content to a channel
Monitor account health
- Schedule Trigger (every 5 minutes)
- Messaging Gateway Account > List
- IF node to filter disconnected accounts
- Email node to alert the operations team
Development
# Install dependencies
npm install
# Type-check
npm run lint
# Build
npm run build