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 for automating the management of Chatwoot settings within workflows, such as toggling integration on or off, verifying connection status, and configuring various Chatwoot options like message import, contact merging, and inbox creation.

Practical examples include:

  • Automatically enabling Chatwoot integration when a new customer support instance is created.
  • Checking if Chatwoot integration is active before sending messages.
  • Configuring Chatwoot settings dynamically based on workflow conditions.

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 integration ("Set Chatwoot") or checking Chatwoot ("Check Chatwoot").
Enable Chatwoot Boolean to enable or disable integration with Chatwoot (only for "Set Chatwoot" operation).
Chatwoot URL The URL of the Chatwoot server.
Chatwoot Account ID The account ID associated with Chatwoot.
Chatwoot Admin Token The admin token used for authenticating with Chatwoot (entered securely).
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: 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 import messages.
Create Inbox Boolean to enable or disable automatic creation of an inbox in Chatwoot.
QRCode Contact Name In Chatwoot Optional: Name for the QRCode contact in Chatwoot.
Logo URL For Contact In Chatwoot Optional: URL of the logo image for the contact in Chatwoot.

Output

The node outputs JSON data representing the result of the requested Chatwoot operation. This typically includes confirmation of the action performed (e.g., enabling/disabling integration), status information, or details retrieved from Chatwoot when checking integration status.

If binary data were involved (not indicated here), it would represent files or media related to Chatwoot interactions, but this node focuses on JSON responses.

Dependencies

  • Requires an active connection to the Evolution API service.
  • Needs valid credentials including an API key or admin token for authentication with Chatwoot.
  • The node expects the Chatwoot URL and account details to be correctly configured.
  • No additional environment variables are explicitly required beyond standard n8n credential setup.

Troubleshooting

  • Common Issues:

    • Incorrect or missing Chatwoot URL or account ID can cause authentication failures.
    • Invalid or expired admin tokens will prevent successful API calls.
    • Network connectivity issues may block communication with the Evolution API or Chatwoot servers.
    • Misconfiguration of boolean flags (e.g., enabling features not supported by the Chatwoot instance) might lead to unexpected behavior.
  • Error Messages:

    • "Unsupported operation." indicates that the selected operation is not implemented for the chosen resource.
    • Authentication errors usually mention invalid credentials or unauthorized access; verify tokens and permissions.
    • Validation errors may occur if required fields are empty or incorrectly formatted; ensure all mandatory properties are provided.

To resolve these, double-check all input parameters, confirm credentials are valid, and ensure network access to the Chatwoot and Evolution API endpoints.

Links and References

Discussion