Evolution API icon

Evolution API

Interact with Evolution API

Overview

The node "Evolution API" allows users to interact with the Evolution API, specifically supporting operations on various resources. For the provided Resource "Instance" and Operation "Set Presence," this node sets the presence status of a specified instance. This is useful in scenarios where you want to programmatically update or manage the availability state of an instance within the Evolution system, such as marking it as "Available" or "Unavailable."

Practical examples include:

  • Automatically setting an instance's presence to "Unavailable" during maintenance windows.
  • Marking an instance as "Available" once it has completed startup or initialization.

Properties

Name Meaning
Instance Name The name identifier of the instance whose presence status you want to set.
Presence The desired presence status for the instance. Options: "Available" or "Unavailable".

Output

The node outputs a JSON array containing the result of the presence update operation. The exact structure depends on the Evolution API response but generally includes confirmation of the updated presence status or any relevant metadata returned by the API.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The node uses the base URL https://doc.evolution-api.com/api-reference for API requests.
  • Proper configuration of the API authentication token or key 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 "Instance" and "Set Presence" respectively.
  • Authentication errors: Ensure the API key or authentication token is valid and properly configured in the node credentials.
  • Invalid instance name: Providing an incorrect or non-existent instance name may cause the API to reject the request; double-check the instance name spelling and existence.
  • Network issues: Connectivity problems to the Evolution API endpoint can cause failures; verify network access and API availability.

Links and References

Discussion