Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node interacts with the Evolution API, allowing users to perform various operations on different resources managed by the API. Specifically, for the "Instancia" resource and the "Reiniciar Instancia" operation, the node enables restarting a specified instance by its name. This is useful in scenarios where an instance needs to be rebooted due to maintenance, updates, or troubleshooting issues.

Practical examples include:

  • Restarting a server instance after deploying new configurations.
  • Rebooting a service instance that has become unresponsive.
  • Automating instance restarts as part of a scheduled workflow.

Properties

Name Meaning
Nome Da Insticância The name of the instance you want to restart. This is a required string input property.

Output

The node outputs a JSON array containing the response from the Evolution API after attempting to restart the specified instance. The exact structure depends on the API's response but typically includes status information about the restart operation.

If the API returns any binary data (not indicated in the provided code), it would be included accordingly, but based on the static analysis, the output is JSON only.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The node expects the Evolution API to be accessible and properly configured.
  • No additional environment variables or external dependencies are indicated.

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 "restart-instance" respectively.
  • Authentication errors: Ensure the API key credential is valid and has sufficient permissions to restart instances.
  • Instance not found: If the specified instance name does not exist, the API may return an error; double-check the instance name spelling.
  • Network issues: Confirm that the Evolution API endpoint is reachable from the n8n environment.

Links and References

  • Evolution API official documentation (link not provided in source)
  • n8n documentation on creating custom nodes and using credentials

Discussion