Evolution API icon

Evolution API

Complete WhatsApp automation with Evolution API
Join our community

Actions48

Overview

This node integrates with the Evolution API to automate WhatsApp messaging tasks. Specifically, the Send List operation under the Message resource allows users to send interactive list messages to WhatsApp contacts. Interactive lists are useful for presenting multiple options in a structured format, enabling recipients to select from predefined choices easily.

Common scenarios where this node is beneficial include:

  • Customer support bots offering menu options.
  • Marketing campaigns providing product or service selections.
  • Surveys or feedback forms delivered via WhatsApp.

For example, a business can send a list of available services to a customer, who can then tap on an option to proceed with booking or inquiries.

Properties

Name Meaning
Phone Number The recipient's phone number including country code (without the "+" sign).
Additional Fields Optional parameters to customize message sending:
- Delay: Time in milliseconds to wait before sending the message.
- Link Preview: Enable or disable link previews in the message.
- Quoted Message ID: ID of a message to quote or reply to.
- Mentions: Comma-separated list of phone numbers to mention in the message.

Output

The node outputs a JSON object containing the response from the Evolution API after attempting to send the list message. This typically includes details about the message status, any errors, and metadata returned by the API.

If the operation fails and "Continue On Fail" is enabled, the output will contain an error message describing the failure.

No binary data output is produced by this operation.

Dependencies

  • Requires an active subscription and valid API keys for both the Evolution API and an auxiliary validation API (referred to generically as "N8N Tools API").
  • The node expects credentials that provide:
    • Base URL for the Evolution API.
    • API key for authentication.
    • Instance name identifying the WhatsApp instance.
  • Proper configuration of these credentials within n8n is necessary for successful execution.

Troubleshooting

  • Invalid Subscription or API Key: If the auxiliary validation API returns a 401 or 403 error, it indicates invalid or expired API keys. Verify and update your credentials accordingly.
  • Unknown Operation or Resource Errors: Selecting unsupported operations or resources will throw errors. Ensure the operation "sendList" is selected under the "message" resource.
  • Network or API Errors: Connectivity issues or API downtime may cause request failures. Check network connectivity and API service status.
  • Incorrect Phone Number Format: Phone numbers must include the country code without the "+" sign. Incorrect formatting may lead to message delivery failure.

Links and References

Discussion