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 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:

  • Fetching an instance's details before performing further automation steps.
  • Integrating instance data into workflows for reporting or alerting.
  • Validating instance existence or properties during deployment pipelines.

Properties

Name Meaning
Instance Name Enter the name of the instance you want to search. This string identifies which instance to fetch from the Evolution API.

Output

The node outputs a JSON array containing the fetched instance data. Each item in the array corresponds to one instance's details as returned by the Evolution API. The exact structure depends on the API response but typically includes instance attributes such as ID, name, status, and other metadata.

No binary data output is indicated.

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.
  • The node expects JSON responses and sends requests with appropriate headers (Accept: application/json, Content-Type: application/json).

Troubleshooting

  • Operation not supported error: If you select an unsupported operation or resource, the node throws an error indicating the function is not supported. Ensure that the Resource is set to "Instance" and Operation to "Fetch Instance."
  • Authentication errors: Make sure the API key credential is correctly configured and has sufficient permissions.
  • Empty or no results: Verify that the "Instance Name" property matches an existing instance in the Evolution API.
  • Network or API errors: Check connectivity and API availability; ensure the base URL is correct and accessible.

Links and References

Discussion