Overview
This node triggers workflows when there are changes in the status of a WhatsApp session. It listens for specific session events such as connection or disconnection updates and activates the workflow accordingly. This is useful for monitoring the health and state of a WhatsApp integration, enabling automated responses to session changes like reconnecting, alerting users, or logging status updates.
Practical examples include:
- Automatically notifying an admin when the WhatsApp session disconnects.
- Logging session status changes for audit or debugging purposes.
- Triggering recovery workflows to re-establish connections after disconnections.
Properties
| Name | Meaning |
|---|---|
| Remember to configure WhatsApp instance (session or server) to send events to Webhook URL | Informational notice reminding to set up the WhatsApp instance to send events to this webhook URL. |
| Events | The types of session events to listen for. Options: "Session Status" (session status updates such as connected, disconnected, etc.) |
Output
The node outputs JSON data representing the event received from the WhatsApp session webhook. The output JSON contains the full body of the webhook request, which includes details about the session event (e.g., status change). This allows downstream nodes to access all relevant information about the session update.
No binary data is produced by this node.
Dependencies
- Requires a configured WhatsApp instance (either session-based or server-based) that sends session event notifications to the webhook URL exposed by this node.
- No additional external API keys or credentials are required within this node itself, but proper setup of the WhatsApp integration is necessary.
Troubleshooting
Common issue: The node does not trigger even though session events occur.
- Cause: The WhatsApp instance may not be correctly configured to send events to the webhook URL.
- Resolution: Ensure the WhatsApp session or server is set up to POST events to the webhook path provided by this node (
whatsapp-session).
Common error: Workflow receives no data or empty payload.
- Cause: The event type sent by WhatsApp is not included in the selected "Events" property.
- Resolution: Verify that the event types you want to listen for are selected in the node’s "Events" property.
Links and References
- WhatsApp Business API Documentation
- n8n Webhook Node Documentation: https://docs.n8n.io/nodes/n8n-nodes-base.webhook/