Evolution API icon

Evolution API

Interact with Evolution API

Actions114

Integration → Chatwoot

AI-generated

Overview

This node integrates with the Chatwoot service within the Evolution API, allowing users to enable, disable, or check the status of Chatwoot integration for a specified instance. It is useful for managing Chatwoot settings programmatically, such as enabling the integration, configuring account details, and managing message and contact import options.

Use Case Examples

  1. Enable Chatwoot integration for a customer support instance by providing the Chatwoot URL, account ID, and admin token.
  2. Check the current status of Chatwoot integration for an instance to verify if it is enabled or disabled.

Properties

Name Meaning
Instance Name The name of the instance that will send the message, used to identify the integration context.
What Do You Want To Do Choose between enabling/disabling Chatwoot integration or checking its status.
Enable Chatwoot Boolean flag to enable or disable the Chatwoot integration (only when setting Chatwoot).
Chatwoot URL The URL of the Chatwoot instance to connect to.
Chatwoot Account ID The account ID in Chatwoot for the integration.
Chatwoot Admin Token Admin token for authenticating with Chatwoot API.
Chatwoot Agent Signature Flag to enable or disable the Chatwoot agent signature on messages.
Reopen Messages In Chatwoot Flag to enable or disable reopening conversations in Chatwoot.
Start Conversations As Pending In Chatwoot Flag to start new conversations as pending in Chatwoot.
Import Contacts To Chatwoot Flag to enable or disable importing contacts to Chatwoot.
Chatwoot Inbox Name Optional name of the Chatwoot inbox to use.
Merge Brazilian Contacts In Chatwoot Flag to enable or disable merging Brazilian contacts in Chatwoot.
Import Messages To Chatwoot Flag to enable or disable importing messages to Chatwoot.
Import Messages From How Many Days To Chatwoot Optional number of days to limit message import to Chatwoot.
Create Inbox Flag to enable or disable automatic creation of inbox in Chatwoot.
QRCode Contact Name In Chatwoot Optional QRCode contact name in Chatwoot.
Logo URL For Contact In Chatwoot Optional URL for the logo of the contact in Chatwoot.

Output

JSON

  • status - The status of the Chatwoot integration operation (e.g., success, failure).
  • message - A descriptive message about the result of the operation.
  • data - Additional data returned from the Chatwoot API related to the integration settings or status.

Dependencies

  • Requires Chatwoot API access with admin token for authentication.

Troubleshooting

  • Ensure the Chatwoot URL and account ID are correct and accessible from the node environment.
  • Verify that the Chatwoot admin token is valid and has sufficient permissions to perform the requested operations.
  • If enabling or disabling integration fails, check network connectivity and API endpoint availability.
  • Error messages related to authentication usually indicate invalid or expired tokens; refresh or regenerate the token as needed.

Links

Discussion