Evolution API

Interagir com a Evolution API v2
Join our community

Actions53

Overview

This node integrates with the Evolution API v2 to send WhatsApp list messages. Specifically, the "Mensagem" resource with the "Enviar Lista" operation allows users to send interactive list messages to a specified recipient number via a configured instance.

Such a node is beneficial in scenarios where you want to present multiple selectable options to a user within a WhatsApp conversation, for example:

  • Sending a product catalog with categories and items.
  • Offering menu choices in customer support or ordering systems.
  • Presenting event schedules or service options interactively.

By using this node, workflows can automate sending structured lists that improve user engagement and streamline decision-making processes on WhatsApp.

Properties

Name Meaning
Instance Name The name of the Evolution API instance to use for sending the message.
Number The recipient's phone number to which the list message will be sent.
List Title The main title of the list message displayed to the recipient.
List Description A description text providing additional context about the list.
List Button Text The label text shown on the button that opens the list options (default: "Ver opções").
List Footer Text Footer text displayed at the bottom of the list message.
List Sections One or more sections of the list, each containing:
- Section Title: The title of the section.
- Rows: Multiple rows/items within the section, each with:
- Title: The row/item title.
- Description: Additional description for the row/item.
- Row ID: Unique identifier for the row/item used internally when selected by the user.

Output

The node outputs a JSON object representing the response from the Evolution API after attempting to send the list message. The output includes:

  • The API response data fields (varies depending on the API).
  • A success boolean indicating if the operation was successful.
  • A timestamp field with the time of execution.

If the API returns an array of responses, the node parses and outputs them as an array of JSON objects.

No binary data output is produced by this operation.

Dependencies

  • Requires an authenticated connection to the Evolution API v2 via an API key credential configured in n8n.
  • The node uses HTTP requests to the Evolution API endpoints.
  • Proper configuration of the "Instance Name" is necessary to identify which WhatsApp instance to send the message through.

Troubleshooting

  • Common Issues:

    • Invalid or missing instance name may cause failures connecting to the API.
    • Incorrect recipient number format could result in message delivery errors.
    • Malformed list sections or missing required fields (like row IDs) might cause API rejections.
    • Network or authentication issues with the Evolution API can prevent message sending.

  • Error Messages:

    • Errors returned from the API are passed through; typical messages include authentication failures, invalid parameters, or quota limits.
    • If the node throws an error, verify the instance credentials and parameter correctness.
    • To handle intermittent failures, enable "Continue On Fail" in the node settings to allow workflow continuation.

Links and References

Discussion