Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node provides integration with the Evolution API, allowing users to perform various operations on different resources managed by the API. Specifically, for the "Instance" resource and the "Restart Instance" operation, the node enables restarting a named instance within the Evolution system. This can be useful in scenarios where an instance needs to be rebooted due to configuration changes, performance issues, or error recovery.

Practical examples include:

  • Automatically restarting an instance after deploying new configurations.
  • Scheduling restarts during maintenance windows.
  • Triggering restarts based on monitoring alerts.

Properties

Name Meaning
Instance Name The name of the instance you want to restart

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 request (e.g., success confirmation, error messages).

No binary data output is indicated.

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.
  • Proper network access to the Evolution API endpoint 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 as "instances-api" and "restart-instance" respectively.
  • Authentication errors: Ensure the API key credential is valid and has sufficient permissions.
  • Network issues: Confirm that the server running n8n can reach the Evolution API endpoint.
  • Invalid instance name: If the instance name does not exist or is misspelled, the API may return an error; double-check the instance name input.

Links and References

Discussion