ChatWoot

Consume ChatWoot API

Actions11

Overview

The ChatWoot node for n8n allows you to interact with the ChatWoot API, specifically targeting the "Account" resource and its "Information" operation. This node is useful for retrieving information about a specific ChatWoot account, such as its details or configuration. Common scenarios include automating account audits, integrating ChatWoot account data into dashboards, or triggering workflows based on account status.

Practical Example:
You might use this node to fetch your ChatWoot account's metadata and then send a summary via email, log it in a database, or trigger alerts if certain account properties change.

Properties

Below are the supported input properties relevant to the Account → Information operation:

Display Name	Type	Meaning
Authentication	options	Select how to authenticate: either by providing parameters directly or using saved credentials.
BaseUrl	string	The base URL of your ChatWoot instance (e.g., `https://chatwoot.org`). Required if using parameter-based authentication.
Access Token	string	Your ChatWoot access token. Used to authorize API requests. Required if using parameter-based authentication.
Account ID	string	(Optional) The specific Account ID to reference. If provided, this overrides the Account ID from credentials.

Output

The output will be a JSON object containing the account information retrieved from the ChatWoot API. The structure typically includes fields such as:

{
  "id": "string",
  "name": "string",
  "email": "string",
  "created_at": "string",
  "updated_at": "string",
  // ...other account-specific fields
}

Each item in the output array represents one account's information.
If an error occurs and "Continue On Fail" is enabled, the output may contain an error field with the error message.

Dependencies

External Service: Requires access to a ChatWoot instance with API enabled.
API Key: You must provide a valid ChatWoot Access Token.
n8n Credentials: Optionally, you can configure and use predefined ChatWoot credentials within n8n.
Environment Variables: None required unless your n8n instance is configured to load credentials from environment variables.

Troubleshooting

Common Issues:

Authentication Errors:
- Error Message: "Authentication failed" or similar.
  Resolution: Ensure that the Access Token and BaseUrl are correct. If using credentials, verify they are properly set up in n8n.
Invalid Account ID:
- Error Message: "Account not found" or similar.
  Resolution: Double-check the Account ID. Leave blank to use the default from credentials.
Network/Connection Issues:
- Error Message: "ENOTFOUND", "ECONNREFUSED", etc.
  Resolution: Verify that the BaseUrl is reachable from your n8n instance.

Other Notes:

If "Continue On Fail" is enabled, errors will appear in the output as objects with an error property instead of stopping the workflow.