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 Instance resource and the Set Presence operation, it enables setting the presence status of a given instance. This is useful in scenarios where you want to programmatically update or reflect the availability status of an instance within the Evolution system, such as marking an instance as available or unavailable based on external triggers or workflows.

Practical examples include:

  • Automatically marking an instance as "available" when a related service starts.
  • Setting an instance to "unavailable" during maintenance windows or outages.

Properties

Name Meaning
Name Da Instância The name identifier of the instance whose presence status you want to set.
Presença The presence status to assign to the instance. Options: "Disponível" (available), "Indisponível" (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 base URL for requests is https://doc.evolution-api.com/api-reference.
  • Proper configuration of the API authentication credentials in n8n is necessary.

Troubleshooting

  • Operation not supported error: If you select an unsupported operation or resource, the node throws an error indicating the operation is not supported. Ensure that the resource is "instances-api" and the operation is "set-presence".
  • Authentication errors: If the API key or credentials are missing or invalid, the node will fail to authenticate. Verify that the correct API key credential is configured.
  • Invalid instance name: Providing an incorrect or non-existent instance name may cause the API to return an error. Double-check the instance name input.
  • Network issues: Connectivity problems to the Evolution API endpoint can cause failures. Confirm network access and endpoint availability.

Links and References

Discussion