Evolution API icon

Evolution API

Interact with Evolution API

Overview

The node provides an interface to interact with the Evolution API, specifically allowing users to configure settings for an "Instance" resource. The "Set Behavior" operation lets users customize how the instance behaves in terms of call handling, message reading, online status, and synchronization preferences.

This node is beneficial when automating or managing communication instances programmatically, such as setting auto-reject for calls with a custom message, controlling whether the instance appears always online, or deciding if message read statuses should be updated automatically.

Practical examples include:

  • Automatically rejecting incoming calls with a predefined message during off-hours.
  • Keeping the instance always online to ensure constant availability.
  • Syncing full message history for backup or audit purposes.

Properties

Name Meaning
Instance Name The name identifier for the instance to configure.
Reject Calls Boolean flag to enable or disable automatic rejection of incoming calls.
Call Message Custom message sent to callers when calls are rejected.
Ignore Groups Boolean flag indicating whether group mentions should be ignored or not.
Always Online Boolean flag to keep the instance always online regardless of activity.
Read Messages Boolean flag to mark messages as read automatically.
Sync Full History Boolean flag to synchronize the entire message history for the instance.
Read Status Boolean flag to update or maintain the read status of messages.

Output

The node outputs a JSON array containing the result of the "Set Behavior" operation on the specified instance. The exact structure depends on the Evolution API response but generally includes confirmation of the updated settings or error details if the operation failed.

No binary data output is indicated by the source code.

Dependencies

  • Requires an active connection to the Evolution API service.
  • Needs an API authentication token or key configured in n8n credentials (referred generically as "an API key credential").
  • Network access to https://doc.evolution-api.com/api-reference endpoint.

Troubleshooting

  • Operation not supported error: If the selected resource-operation combination is invalid or not implemented, the node throws an error stating the operation is unsupported. Ensure that "Instance" resource and "Set Behavior" operation are correctly selected.
  • Authentication errors: Failure to authenticate with the Evolution API will prevent execution. Verify that the API key credential is valid and has necessary permissions.
  • Invalid input properties: Missing required fields like "Instance Name" may cause the API call to fail. Double-check all required inputs are provided.
  • Network issues: Connectivity problems to the Evolution API endpoint can cause timeouts or failures. Confirm network accessibility.

Links and References

Discussion