Evolution API icon

Evolution API

Interact with Evolution API

Overview

The node named "Evolution API" allows users to interact with the Evolution API service. Specifically, for the resource "Instance" and operation "Delete Instance," it enables deleting a specified instance by its name. This is useful in scenarios where you need to programmatically remove instances from your Evolution API environment, such as cleaning up unused or test instances, automating lifecycle management, or integrating instance deletion into larger workflows.

Example use cases:

  • Automatically delete an instance after a certain event or condition is met.
  • Clean up stale or temporary instances created during testing.
  • Manage instances dynamically as part of deployment or maintenance pipelines.

Properties

Name Meaning
Instance Name Enter the name of the instance that will be deleted

This property is required and expects a string input representing the exact name of the instance to delete.

Output

The node outputs a JSON array containing the result of the delete operation. The structure of the output JSON depends on the response from the Evolution API but typically includes confirmation of deletion or relevant status information.

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.
  • Proper configuration of the API authentication within n8n credentials is necessary.

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 "instances-api" and "delete-instance" respectively.
  • Authentication errors: Ensure the API key credential is valid and has sufficient permissions to delete instances.
  • Instance not found: If the specified instance name does not exist, the API may return an error or empty response; double-check the instance name spelling and existence.
  • Network or API errors: Check network connectivity and API availability; review API rate limits or restrictions.

Links and References

Discussion