Evolution API

Interagir com a Evolution API v2
Join our community

Actions53

Overview

This node integrates with the Evolution API v2 to manage and interact with WhatsApp instances and related messaging features. Specifically, the "Conectar Instância" (Connect Instance) operation under the "Instância" (Instance) resource allows users to establish a connection to a specified WhatsApp instance by its name.

Common scenarios where this node is beneficial include:

  • Automating the connection process to a WhatsApp instance before sending or receiving messages.
  • Managing multiple WhatsApp instances programmatically within workflows.
  • Ensuring that an instance is connected and ready for further operations such as messaging or group management.

Practical example:

  • Before sending a message through a WhatsApp instance, use this node to connect to the instance by providing its name. Once connected, subsequent nodes can send messages or perform other actions on that instance.

Properties

Name Meaning
Instance Name The name of the WhatsApp instance to connect to. This identifies which instance the node will attempt to connect. It is a required string input.

Output

The output JSON contains the response from the Evolution API after attempting to connect to the specified instance. The structure typically includes:

  • success: A boolean indicating if the operation was successful.
  • Other fields returned by the API endpoint /instance/connect/{instanceName}, which may include connection details or status.
  • timestamp: The ISO string timestamp when the operation was performed.

If the API returns no data (null), the node outputs a default success message with a timestamp.

If the API returns a string, the node attempts to parse it as JSON; if parsing fails, it wraps the string in a value field.

If the API returns an array, each element is parsed similarly.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential configured in n8n to authenticate requests to the Evolution API.
  • The node uses the Evolution API v2 endpoints, specifically the /instance/connect/{instanceName} GET endpoint.
  • Proper network access to the Evolution API service is necessary.

Troubleshooting

  • Common issues:

    • Providing an incorrect or non-existent instance name will likely cause the API to return an error or fail to connect.
    • Network connectivity issues or invalid API credentials will prevent successful connection.

  • Error messages:

    • Errors thrown by the API are caught and returned as error messages in the output if "Continue On Fail" is enabled.
    • Typical errors might include authentication failures, instance not found, or server errors.

  • Resolution tips:

    • Verify the instance name is correct and exists in your Evolution API account.
    • Ensure the API key credential is valid and has the necessary permissions.
    • Check network connectivity and API endpoint availability.
    • Enable "Continue On Fail" in the node settings to handle errors gracefully in workflows.

Links and References

Discussion