Evolution API icon

Evolution API

Interact with Evolution API

Overview

This n8n node allows you to define or check the proxy settings for a specific "Instancia" (Instance) in the Evolution API. It is useful when you need to programmatically enable, disable, or verify proxy configurations for your instances, such as routing traffic through a proxy server for security, compliance, or network management purposes.

Common scenarios:

  • Automatically enabling/disabling a proxy for an instance before performing sensitive operations.
  • Verifying current proxy settings to ensure correct network routing.
  • Integrating with workflows that require dynamic proxy configuration based on external triggers.

Practical example:
You might use this node in a workflow where, before sending messages from an instance, you want to ensure all traffic goes through a specified HTTP/HTTPS proxy, or you want to check if the proxy is currently enabled and correctly configured.


Properties

Display Name Type Description
Nome Da Instancia String Digite o nome da instância que vai enviar a mensagem (Name of the instance to configure).
O Que Deseja Fazer Options Escolha entre ativar/desativar proxy ou verificar o proxy (Choose to set or check proxy).
Ativar Proxy Boolean Whether to enable or disable integration with proxy.
Protocolo Do Proxy Options Selecione o protocolo do proxy (Select proxy protocol: HTTP or HTTPS).
Host Do Proxy String Digite o host do proxy (Proxy server hostname).
Porta Do Proxy String Digite a porta do proxy (Proxy server port).
Usuário Do Proxy String Digite o usuário do proxy (Proxy username).
Senha Do Proxy String Digite a senha do proxy (Proxy password; input is masked).

Note:

  • Some fields are only required when setting the proxy ("Definir Proxy"), not when checking it ("Verificar Proxy").

Output

The node outputs a JSON object containing the result of the proxy operation. The structure may vary depending on whether you are defining or checking the proxy, but typically includes:

  • Status of the operation (success/failure).
  • Details about the proxy configuration (if checking).
  • Any relevant messages or error information.

Example output (for "Definir Proxy"):

{
  "status": "success",
  "message": "Proxy definido com sucesso.",
  "proxy": {
    "enabled": true,
    "protocol": "http",
    "host": "proxy.example.com",
    "port": "1234",
    "username": "user"
  }
}

Example output (for "Verificar Proxy"):

{
  "status": "success",
  "proxy": {
    "enabled": true,
    "protocol": "https",
    "host": "proxy.example.com",
    "port": "1234",
    "username": "user"
  }
}

If the node can output binary data, it is not applicable in this context.


Dependencies

  • External Service: Requires access to the Evolution API.
  • API Key: You must provide valid credentials for the "evolutionApi" credential type in n8n.
  • Environment: Ensure the Evolution API endpoint is reachable from your n8n instance.

Troubleshooting

Common issues:

  • Missing or invalid credentials: If the "evolutionApi" credentials are not set up or are incorrect, the node will fail to authenticate.
  • Unsupported operation: If you select an unsupported resource or operation, you may see an error like:
    • "Operação não suportada."
      Resolution: Check that you have selected a valid combination of Resource and Operation.
  • Network errors: If the Evolution API is unreachable, you may receive connection or timeout errors.
  • Required fields missing: When setting a proxy, ensure all required fields (host, port, username, password) are filled.

Links and References

Discussion