Overview
This node sends an interactive WhatsApp Flow message using the WhatsApp Business API. It allows users to initiate a predefined WhatsApp Flow (a guided interactive conversation) by specifying details such as the recipient's phone number, the flow ID, and initial screen. This is useful for automating customer interactions, guiding users through multi-step processes, or delivering rich interactive content on WhatsApp.
Common scenarios:
- Automating customer support flows where users are guided through troubleshooting steps.
- Sending onboarding sequences or surveys via WhatsApp.
- Triggering marketing or transactional flows that require user interaction.
Example:
A company wants to send a welcome flow to new customers on WhatsApp. Using this node, they specify the customer's phone number, the flow ID of the welcome sequence, and initial data to personalize the experience. The customer receives an interactive message with header, body, footer text, and a button to start the flow.
Properties
| Name | Meaning |
|---|---|
| Phone Number ID | ID of the WhatsApp Business phone number used to send the message. |
| Numéro De Téléphone Destinataire | Recipient's phone number in international format (e.g., +33123456789). |
| Flow ID | ID of the WhatsApp Flow to send. |
| Initial Screen | ID of the initial screen within the WhatsApp Flow to start from. |
| Texte Du Header | Optional header text displayed at the top of the interactive message. |
| Texte Du Body | Main body text of the interactive message (required). |
| Texte Du Footer | Optional footer text displayed at the bottom of the message. |
| Texte Du Bouton | Text displayed on the button that launches the Flow (default: "Commencer"). |
| Données Initiales Du Flow | JSON object containing initial data passed to the Flow when it starts (must be valid JSON). |
Output
The node outputs an array of JSON objects, one per input item, each containing:
success: Boolean indicating if the message was sent successfully.messageId: The unique ID of the sent WhatsApp message (present if successful).to: The recipient phone number.flowId: The ID of the WhatsApp Flow sent.response: The full response data returned by the WhatsApp API.error: If sending failed, contains error details from the API or the error message.
No binary data output is produced by this node.
Dependencies
- Requires an API authentication token credential for the WhatsApp Business API.
- Uses the WhatsApp Cloud API endpoint (
https://graph.facebook.com/v21.0/{phoneNumberId}/messages) to send messages. - Requires network access to Facebook's Graph API.
- The node expects the provided JSON in "Données Initiales Du Flow" to be valid; otherwise, it throws an error.
Troubleshooting
Invalid JSON in Flow Data:
Error: "Données Flow invalides - doit être un JSON valide"
Cause: The "Données Initiales Du Flow" property contains malformed JSON.
Solution: Ensure the JSON string is correctly formatted.API Authentication Errors:
If the API token is missing, expired, or invalid, the request will fail.
Solution: Verify the API key credential is correctly configured and has necessary permissions.Incorrect Phone Number Format:
The recipient phone number must be in international format without non-digit characters.
Solution: Use the format like "+33123456789". The node strips non-digit characters automatically but ensure correctness.Flow or Screen IDs Invalid:
If the specified Flow ID or Initial Screen ID does not exist or is incorrect, the API may return an error.
Solution: Double-check the IDs in your WhatsApp Business account.Network Issues:
Failure to reach the Facebook Graph API endpoint will cause errors.
Solution: Check internet connectivity and firewall settings.