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 resource "Instancia" and operation "Definir Presença" (Set Presence), it enables setting the presence status of a given instance by its name. This is useful in scenarios where you want to programmatically update or manage the availability status of instances within the Evolution system, such as marking an instance as available or unavailable.

Practical examples include:

  • Automatically marking an instance as "available" when it comes online.
  • Setting an instance to "unavailable" during maintenance windows or outages.

Properties

Name Meaning
Nome Da Instância The name 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-setting operation. The exact structure depends on the Evolution API response but generally includes confirmation of the updated presence status for the specified instance.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The node expects the Evolution API endpoint to be accessible.
  • Proper configuration of the API authentication credentials in n8n is necessary.

Troubleshooting

  • Unsupported Operation Error: If the node throws an error stating the operation is not supported, verify that the resource is set to "Instancia" and the operation to "Definir Presença". This error indicates a mismatch or unsupported combination.
  • Authentication Failures: Ensure the API key credential is correctly configured and has sufficient permissions.
  • Invalid Instance Name: Providing an incorrect or non-existent instance name may cause the API to reject the request or return an error.
  • Network Issues: Connectivity problems to the Evolution API endpoint will prevent successful execution.

Links and References

Discussion