Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node interacts with the Evolution API to manage proxy settings for instances. It supports two main operations under the "Instance" resource: setting a proxy configuration and checking (finding) the current proxy status.

Typical use cases include:

  • Enabling or disabling proxy integration for an instance that sends messages.
  • Configuring proxy details such as protocol, host, port, username, and password.
  • Verifying if a proxy is currently set for an instance.

For example, you might use this node to programmatically configure proxy settings for an instance before sending data through it, or to check whether proxy settings are active.

Properties

Name Meaning
Instance Name The name of the instance that will send the message.
What Do You Want To Do Choose between enabling/disabling the proxy ("Set Proxy") or checking the proxy status ("Check Proxy").
Enable Proxy Boolean flag to enable or disable proxy integration (only applicable when setting proxy).
Proxy Protocol The protocol used by the proxy; options are HTTP or HTTPS.
Proxy Host The hostname or IP address of the proxy server.
Proxy Port The port number on which the proxy server listens.
Proxy Username Username credential for authenticating with the proxy server.
Proxy Password Password credential for authenticating with the proxy server.

Output

The node outputs a JSON array containing the result of the requested operation:

  • For Set Proxy: The output typically confirms whether the proxy was successfully enabled or disabled with the provided settings.
  • For Check Proxy: The output returns the current proxy configuration or status for the specified instance.

No binary data output is indicated in the source code.

Dependencies

  • Requires an API key or authentication token configured in n8n credentials to access the Evolution API.
  • The node makes HTTP requests to the Evolution API endpoint at https://doc.evolution-api.com/api-reference.
  • No other external dependencies are explicitly required.

Troubleshooting

  • Operation not supported error: If you select an unsupported operation or resource, the node throws an error indicating the function is not supported. Ensure you use only the supported operations "set-proxy" or "find-proxy" under the "instances-api" resource.
  • Missing required properties: When setting a proxy, all proxy details including host, port, username, and password must be provided. Omitting any required field may cause the API call to fail.
  • Authentication errors: Make sure the API credentials are correctly configured in n8n to avoid authorization failures.
  • Network issues: Proxy settings depend on network accessibility; incorrect proxy host or port can lead to connection failures.

Links and References

Discussion