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 provided Resource "Instance" and Operation "Fetch Instance," it enables fetching details about a particular instance by its name. This is useful in scenarios where you need to retrieve information about specific instances managed or tracked by the Evolution API, such as monitoring instance status, configuration, or metadata.

Practical examples include:

  • Automating retrieval of instance details for reporting or auditing.
  • Integrating instance data into workflows that require conditional logic based on instance attributes.
  • Synchronizing instance information with other systems or databases.

Properties

Name Meaning
Instance Name Enter the name of the instance you want to search. This string identifies which instance's details to fetch.

Output

The node outputs a JSON array containing the fetched instance data. Each item in the array corresponds to an instance matching the search criteria (in this case, typically one instance identified by the given name). The structure of the JSON output depends on the Evolution API's response format for instance details but generally includes fields describing the instance's properties.

If the node supports binary data output, it would be related to any files or attachments associated with the instance, but no such indication is present here.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The base URL for API requests is https://doc.evolution-api.com/api-reference.
  • The node expects JSON responses and sends requests with appropriate headers (Accept: application/json, Content-Type: application/json).

Troubleshooting

  • Unsupported operation error: If the node throws an error stating the operation is unsupported, verify that the Resource and Operation names are correctly set to "Instance" and "Fetch Instance" respectively.
  • Authentication errors: Ensure that a valid API key credential is configured in n8n for the Evolution API.
  • Empty or no results: If no instance data is returned, confirm that the "Instance Name" property matches an existing instance exactly.
  • Network or API errors: Check network connectivity and that the Evolution API endpoint is reachable. Review API rate limits or permissions if applicable.

Links and References

Discussion