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 "Disconnect Instance," it enables users to disconnect or log out a specified instance by its name. This functionality is useful in scenarios where managing active instances programmatically is required, such as automating session management, cleaning up unused instances, or integrating instance lifecycle control within workflows.

For example, a user might automate the disconnection of an instance after completing certain tasks to free up resources or ensure security by terminating sessions that are no longer needed.

Properties

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

Output

The node outputs a JSON array containing the result of the disconnect operation. The exact structure of the output JSON depends on the Evolution API's response but generally includes confirmation of the instance being disconnected or relevant status information.

No binary data output is indicated in the source code.

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

  • Operation not supported error: If the node throws an error stating the operation is not supported, verify that the resource and operation names are correctly set to "instances-api" and "logout-instance" respectively.
  • Authentication errors: Ensure that a valid API authentication token or key is configured in the node credentials.
  • Instance not found or invalid instance name: If the specified instance name does not exist or is incorrect, the API may return an error or empty response. Double-check the instance name input.
  • Network or API endpoint issues: Confirm network connectivity and that the Evolution API endpoint is reachable.

Links and References

  • Evolution API Documentation (base URL used by the node)
  • Refer to the official Evolution API docs for detailed information about instance management endpoints and expected request/response formats.

Discussion