Evolution API

Interagir com a Evolution API v2
Join our community

Actions53

Overview

This node integrates with the Evolution API v2 to perform various messaging and instance management operations. Specifically, for the Mensagem resource with the Enviar Pix operation, it allows sending a PIX payment message to a specified recipient number via a configured instance.

Common scenarios where this node is beneficial include automating WhatsApp communications that involve sending PIX payment requests or confirmations directly to users, such as in e-commerce, billing notifications, or customer support workflows.

Practical example: Automatically send a PIX payment request to a customer’s WhatsApp number after an order is placed, streamlining payment collection.

Properties

Name Meaning
Instance Name The name of the Evolution API instance to use for sending the message. This identifies which connected WhatsApp instance will send the PIX message.
Number The recipient's phone number to which the PIX message will be sent.

Output

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

  • success: A boolean indicating if the operation was successful.
  • Other fields returned by the API, typically including message IDs or status information.
  • timestamp: The ISO string timestamp when the operation completed.

If the API returns multiple items (e.g., an array), the node parses each item and returns 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 depends on the Evolution API service being accessible and the specified instance being active and connected.
  • Proper configuration of the instance name and recipient number is necessary.

Troubleshooting

  • Common issues:

    • Invalid or inactive instance name: Ensure the instance name matches a connected Evolution API instance.
    • Incorrect recipient number format: Use the international phone number format without special characters.
    • API authentication errors: Verify that the API key credential is valid and has required permissions.
    • Network or API downtime: Check connectivity and Evolution API service status.

  • Common error messages:

    • Authentication failures: "Unauthorized" or similar; resolve by updating API credentials.
    • "Instance not found" or "Instance not connected": Confirm the instance exists and is connected.
    • Validation errors on the number or message payload: Correct input parameters according to API requirements.

Links and References

Discussion