Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node, named "Evolution API," allows users to interact with the Evolution API by performing various operations on different resources. Specifically, for the resource Instance and operation Logout Instance, it enables logging out a specified instance by its name. This can be useful in scenarios where you need to programmatically terminate or invalidate sessions or connections associated with an instance in the Evolution system.

Practical examples include:

  • Automating the logout of instances after certain workflows complete.
  • Managing session lifecycles by logging out inactive or expired instances.
  • Integrating instance management into broader automation pipelines.

Properties

Name Meaning
Instance Name The name of the instance you want to log out. This is a required string input property.

Output

The node outputs a JSON array containing the result of the logout operation. The exact structure depends on the Evolution API's response but typically includes confirmation of the logout action or any relevant status messages.

If the node supports binary data output, it is not indicated in the provided code or properties, so the output is purely JSON-based.

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 the Evolution API to accept and return JSON-formatted data.
  • No additional environment variables or external services are explicitly required beyond the API authentication.

Troubleshooting

  • Unsupported operation error: If you select an operation or resource combination that is not implemented, the node will throw an error stating the function is unsupported. Ensure you use valid resource-operation pairs.
  • Authentication errors: If the API key or credentials are missing or invalid, API calls will fail. Verify that the correct API key credential is configured.
  • Invalid instance name: Providing an incorrect or non-existent instance name may cause the logout operation to fail or return an error from the API. Double-check the instance name before executing.
  • Network issues: Connectivity problems to the Evolution API endpoint will prevent successful execution. Confirm network access and API availability.

Links and References

Discussion