Evolution API

Interagir com a Evolution API v2
Join our community

Actions53

Overview

This node integrates with the Evolution API v2 to send interactive button messages via WhatsApp. It allows users to send messages containing buttons that recipients can tap to reply or open URLs, enhancing engagement and interactivity in messaging workflows.

Common scenarios include:

  • Customer support bots sending quick-reply buttons for common queries.
  • Marketing campaigns with call-to-action buttons linking to promotions or websites.
  • Surveys or polls where users respond by tapping buttons.

For example, a business could send a message with buttons labeled "Yes", "No", and "More Info" to quickly capture customer feedback.

Properties

Name Meaning
Instance Name The name of the WhatsApp instance used to send the message.
Number Recipient's phone number to which the button message will be sent.
Button Title The main title text displayed above the buttons in the message.
Button Description A descriptive text shown below the button title providing context or details.
Buttons Collection of buttons to include in the message. Each button has:
- Button Text The label text shown on the button.
- Button ID Identifier for the button, used internally to track which button was pressed.
- Button Type Type of button: either "Reply" (a quick reply button) or "URL" (opens a web link).

Output

The node outputs a JSON array where each item corresponds to the result of sending a button message for each input item. The output includes:

  • success: Boolean indicating if the operation succeeded.
  • message: Confirmation message when no detailed response is returned.
  • timestamp: ISO string timestamp of the operation.
  • Additional fields returned by the Evolution API related to the sent message.

If the API returns multiple items or strings, they are parsed into JSON objects accordingly.

The node does not output binary data.

Dependencies

  • Requires an API key credential configured in n8n to authenticate requests to the Evolution API.
  • The Evolution API endpoint must be accessible from the n8n environment.
  • Proper configuration of the WhatsApp instance name is required to route messages correctly.

Troubleshooting

  • Invalid Instance Name: If the instance name is incorrect or not connected, the API will fail. Verify the instance exists and is active.
  • Incorrect Phone Number Format: Ensure the recipient number is in the correct international format without extra characters.
  • Button Configuration Errors: Missing button text or IDs may cause the API to reject the request. Provide all required button fields.
  • API Authentication Failures: Check that the API key credential is valid and has necessary permissions.
  • Network Issues: Connectivity problems between n8n and the Evolution API will cause timeouts or errors.

Common error messages typically relate to invalid parameters or authentication failures. Reviewing the API response and ensuring all required properties are set usually resolves these issues.

Links and References

Discussion