Actions17
- Contacts Actions
- SMS Messages Actions
- WhatsApp Messages Actions
- RCS Messages Actions
- Omni Rooms Actions
- Message Templates Actions
Overview
This node integrates with the Yup.chat API to send WhatsApp messages. It supports sending both plain text messages and template-based messages, allowing users to automate communication via WhatsApp efficiently. Typical use cases include customer notifications, alerts, marketing campaigns, or transactional messages where personalized templates are used.
For example:
- Sending a simple text message to a customer confirming an appointment.
- Sending a templated message with parameters like customer name and order ID for order updates.
Properties
| Name | Meaning |
|---|---|
| To | Recipient phone number in E.164 format (e.g., "5511999999999"). |
| From | Sender identifier (optional). |
| Message Type | Type of message to send: Text or Template. |
| Text | The text content to send (used when Message Type is Text). |
| Template ID | ID of the template to use (used when Message Type is Template). |
| Parameters | JSON array of template parameters (used when Message Type is Template). Example: ["John Doe", "order-123"]. |
Output
The node outputs the response from the Yup.chat API as JSON. This typically includes details about the sent message(s), such as message IDs, status, timestamps, or error information if the request failed.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authenticating with the Yup.chat API.
- The base URL for the Yup.chat API defaults to
https://api.yup.chatbut can be configured via credentials. - Proper configuration of the API key credential in n8n is necessary for successful requests.
Troubleshooting
- Invalid phone number format: Ensure the "To" property uses the correct E.164 format (country code + number, no spaces or symbols).
- Authentication errors: Verify that the API key credential is correctly set up and has the required permissions.
- Template errors: When using templates, ensure the template ID exists and the parameters JSON is valid and matches the template placeholders.
- JSON parsing errors: The "Parameters" field must contain valid JSON; otherwise, the node will send an empty parameter list.
- API rate limits or downtime: If the API returns errors related to rate limiting or service availability, retry later or check Yup.chat service status.
If the node encounters an error and "Continue On Fail" is enabled, it will return the error message in the output JSON instead of stopping execution.
Links and References
- Yup.chat API Documentation (for detailed API usage and templates)
- WhatsApp Business API Guidelines (for understanding message types and templates)