Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node integrates with the Chatwoot service via the Evolution API, allowing users to enable, disable, or check the status of Chatwoot integration for a specified instance. It is useful in scenarios where automated workflows need to manage customer support channels, synchronize contacts, import messages, or configure Chatwoot settings programmatically.

Practical examples include:

  • Automatically enabling or disabling Chatwoot integration based on business rules.
  • Importing historical messages and contacts into Chatwoot for unified customer communication.
  • Checking the current Chatwoot integration status before performing further actions.

Properties

Name Meaning
Instance Name The name of the instance that will send the message.
What Do You Want To Do Choose between enabling/disabling Chatwoot ("Set Chatwoot") or checking Chatwoot status ("Check Chatwoot").
Enable Chatwoot Boolean to enable or disable integration with Chatwoot (only for "Set Chatwoot" operation).
Chatwoot Link The URL link to the Chatwoot instance.
Chatwoot Account ID The account ID associated with Chatwoot.
Chatwoot Admin Token The admin token used for authenticating with Chatwoot (entered as a password field).
Chatwoot Agent Signature Boolean to enable or disable the Chatwoot agent signature feature.
Reopen Messages in Chatwoot Boolean to enable or disable reopening messages in Chatwoot conversations.
Start Conversations as Pending in Chatwoot Boolean to start new conversations with a pending status in Chatwoot.
Import Contacts to Chatwoot Boolean to enable or disable importing contacts into Chatwoot.
Chatwoot Inbox Name Optional: The name of the Chatwoot inbox to use.
Merge Brazilian Contacts in Chatwoot Boolean to enable or disable merging of Brazilian contacts in Chatwoot.
Import Messages to Chatwoot Boolean to enable or disable importing messages into Chatwoot.
Import Messages From How Many Days to Chatwoot Optional number specifying how many days back to limit message imports.
Create Inbox Boolean to enable or disable automatic creation of an inbox in Chatwoot.
Chatwoot QRCode Contact Name Optional: Name of the QRCode contact in Chatwoot.
Chatwoot Contact Logo URL Optional: URL of the logo image for the contact in Chatwoot. Defaults to a GitHub assets URL.

Output

The node outputs JSON data representing the result of the requested Chatwoot operation. This typically includes confirmation of the integration status, details about imported contacts or messages, or the current configuration state of Chatwoot integration.

If binary data were involved (e.g., images or files), it would be summarized accordingly, but this node primarily deals with JSON responses related to Chatwoot integration management.

Dependencies

  • Requires an active connection to the Evolution API service.
  • Needs valid credentials including an API key or admin token for authenticating with Chatwoot.
  • Proper configuration of the Chatwoot instance URL and account ID is necessary.
  • No additional environment variables are explicitly required beyond standard API authentication.

Troubleshooting

  • Common Issues:

    • Invalid or missing Chatwoot admin token can cause authentication failures.
    • Incorrect Chatwoot URL or account ID may lead to connection errors.
    • Attempting unsupported operations will throw an error indicating the operation is not supported.
    • Network connectivity issues with the Evolution API or Chatwoot server can cause timeouts or failures.
  • Error Messages:

    • "Operation not supported." — Occurs if the selected operation is not implemented; verify the chosen operation matches available options.
    • Authentication errors — Check that the admin token and account ID are correct and have sufficient permissions.
    • Validation errors — Ensure all required fields marked as mandatory are provided and correctly formatted.

Links and References

Discussion