Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node, named "Evolution API," allows users to interact with the Evolution API service. Specifically, for the "Instance" resource and the "Connect Instance" operation, it enables connecting to a specified instance by its name. This is useful in scenarios where you need to programmatically access or manage instances within the Evolution API ecosystem, such as retrieving instance details or initiating connections for further operations.

Practical examples include:

  • Connecting to a particular instance to fetch its status or configuration.
  • Automating workflows that require interaction with specific instances identified by their names.

Properties

Name Meaning
Name Da Instância The name of the instance you want to connect to. This is a required string input.

Output

The node outputs a JSON array containing the result of the connection operation to the specified instance. The exact structure depends on the Evolution API's response but generally includes details about the connected instance.

If the node supports binary data output, it would typically represent files or media related to the instance, but based on the provided code and properties, this node primarily outputs JSON data.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The base URL for requests is set to https://doc.evolution-api.com/api-reference.
  • Proper configuration of the API authentication credentials within n8n is necessary.

Troubleshooting

  • Operation not supported error: If you receive an error stating the operation is not supported, ensure that the "resource" is set to "instances-api" and the "operation" is "instance-connect". This node only supports predefined resource-operation pairs.
  • Missing or incorrect instance name: Since the instance name is required, leaving it empty or providing an incorrect name will likely cause the API call to fail. Double-check the instance name spelling and existence.
  • Authentication errors: Ensure that the API key credential is correctly configured and has sufficient permissions to perform the connect operation.
  • Network issues: Verify network connectivity to the Evolution API endpoint.

Links and References

Discussion