Evolution API

Overview

The "Buscar Instancia" (Search Instance) operation for the "Instancia" (Instance) resource in this custom n8n node allows users to search for a specific instance by its name using the Evolution API. This is useful in scenarios where you need to retrieve information about a particular instance from the Evolution system, such as checking its status, configuration, or other metadata.

Practical Example:
Suppose you manage multiple instances within the Evolution platform and want to automate monitoring or reporting tasks. You can use this node to fetch details of an instance by providing its name, then process or route the retrieved data further in your workflow.

Properties

Output

The output will be a JSON array containing the details of the found instance(s). The exact structure depends on the Evolution API's response, but typically it may include fields such as:

[
  {
    "id": "string",
    "name": "string",
    "status": "string",
    // ...other instance-specific fields
  }
]

• If no matching instance is found, the array may be empty.
• The node does not output binary data.

Dependencies

• External Service: Requires access to the Evolution API at https://doc.evolution-api.com/api-reference.
• API Key/Credentials: Needs valid credentials configured in n8n under the name evolutionApi.

Troubleshooting

• Common Issues:

  • Invalid Credentials: If the API key or credentials are missing or incorrect, authentication errors will occur.
  • Unsupported Operation: If the selected operation or resource is not implemented, the node throws an error:
    "Operação não suportada."
    How to resolve: Ensure you select a supported resource and operation combination.
  • Empty Results: If the provided instance name does not match any records, the output array will be empty.

• Error Messages:

  • "A função \"<operation>\" para o recurso \"<resource>\" não é suportada!"
    Resolution: Double-check that you have selected the correct resource and operation.

Links and References

• Evolution API Documentation
• n8n Documentation – Custom Nodes