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 route your instance's outbound traffic through a corporate proxy by providing the necessary proxy credentials and connection details.

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 shown when setting proxy).
Proxy Protocol Select the proxy protocol to use: HTTP or HTTPS (only shown when setting proxy).
Proxy Host The hostname or IP address of the proxy server (required when setting proxy).
Proxy Port The port number on which the proxy server listens (required when setting proxy).
Proxy Username Username for authenticating with the proxy server (required when setting proxy).
Proxy Password Password for authenticating with the proxy server (required when setting proxy).

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 along with any relevant status messages.
  • For Check Proxy, the output provides the current proxy configuration or status for the specified instance.

No binary data output is involved.

Dependencies

  • Requires an active connection to the Evolution API service.
  • Needs an API authentication token or key configured in n8n credentials to authorize requests.
  • Network access to the Evolution API endpoint (https://doc.evolution-api.com/api-reference).

Troubleshooting

  • Unsupported operation error: If you select an operation not supported by the node, it will throw an error indicating the function is unsupported. Ensure you choose either "Set Proxy" or "Check Proxy" under the "Instance" resource.
  • Missing required fields: When setting a proxy, all proxy details including host, port, username, and password must be provided. Omitting these will cause errors.
  • Authentication failures: Make sure the API credentials are correctly configured and valid.
  • Network issues: Verify network connectivity to the Evolution API endpoint and proxy server if applicable.

Links and References

Discussion