Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

This node interacts with the Evolution API to manage proxy settings for instances. It supports two main operations under the "Instancia" resource: setting a proxy configuration and checking the current proxy status. This is useful in scenarios where you need to route instance communications through a proxy server, either enabling or disabling it, or verifying the existing proxy setup.

Practical examples include:

  • Enabling a corporate proxy for an instance to comply with network policies.
  • Disabling the proxy when direct internet access is required.
  • Checking if a proxy is currently active on a given instance before performing further actions.

Properties

Name Meaning
Nome Da Instancia The name of the instance that will send the message; identifies which instance to configure.
O Que Deseja Fazer Choose between "Definir Proxy" (set proxy) or "Verificar Proxy" (check proxy status).
Ativar Proxy Boolean option to enable or disable proxy integration (only for setting proxy).
Protocolo Do Proxy Protocol used by the proxy; options are HTTP or HTTPS (only for setting proxy).
Host Do Proxy The hostname or IP address of the proxy server (required when setting proxy).
Porta Do Proxy The port number of the proxy server (required when setting proxy).
Usuário Do Proxy Username for authenticating with the proxy server (required when setting proxy).
Senha Do Proxy 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 setting the proxy, the output typically confirms whether the proxy was successfully enabled or disabled along with any relevant status messages.
  • For checking the proxy, the output provides details about the current proxy configuration status of the specified instance.

No binary data output is involved.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The node depends on the Evolution API endpoint at https://doc.evolution-api.com/api-reference.
  • Proper network access to the Evolution API must be configured in n8n.

Troubleshooting

  • Common issues:

    • Incorrect instance name may cause the API to fail to find the target instance.
    • Missing or invalid proxy credentials (username/password) will prevent successful proxy configuration.
    • Network connectivity issues to the Evolution API endpoint can cause request failures.

  • Error messages:

    • "Operação não suportada." indicates that the selected operation is not implemented or recognized; verify the chosen operation matches supported ones.
    • Authentication errors usually indicate invalid or missing API credentials; ensure the API key is correctly set up.
    • Validation errors for required fields (e.g., proxy host, port, username, password) mean those inputs were omitted or empty; fill all required fields when setting the proxy.

Links and References

Discussion