ChatWoot icon

ChatWoot

Consume ChatWoot API
Join our community

Actions11

Overview

This n8n node interacts with the ChatWoot API, specifically targeting the Account resource and its Information operation. It retrieves information about a specified ChatWoot account. This node is useful for automating workflows that require fetching account details from ChatWoot, such as reporting, monitoring, or integrating ChatWoot account data into other systems.

Practical examples:

  • Automatically pulling account metadata for dashboards.
  • Verifying account configuration in automated QA processes.
  • Integrating ChatWoot account info into CRM or support tools.

Properties

Name Type Meaning
Authentication options Selects the authentication method: either direct parameter input or predefined credentials.
BaseUrl string The base URL of your ChatWoot instance (required if using parameter-based authentication).
Access Token string The access token for ChatWoot API (required if using parameter-based authentication).
Account ID string (Optional) The specific Account ID to fetch information for; overrides credential settings.

Output

The output is a JSON object containing the account information retrieved from the ChatWoot API. The exact structure depends on the ChatWoot API response for the account information endpoint, but typically includes fields such as:

{
  "id": "string",
  "name": "string",
  "email": "string",
  "created_at": "string",
  ...
}

If an error occurs and "Continue On Fail" is enabled, the output will include an error field with the error message.

Dependencies

  • ChatWoot API: Requires access to a ChatWoot instance.
  • API Key / Access Token: Needed for authentication, either via direct parameters or predefined credentials.
  • n8n Credentials: If using predefined credentials, ensure the "ChatWoot Token API" credential is configured in n8n.

Troubleshooting

Common Issues:

  • Authentication errors: Ensure the correct BaseUrl and Access Token are provided, or that the predefined credentials are set up properly.
  • Invalid Account ID: Supplying an incorrect or missing Account ID may result in not finding the account or receiving an error from the API.
  • Network issues: Make sure the n8n instance can reach the ChatWoot server.

Error Messages:

  • "Authentication failed": Check your BaseUrl and Access Token or credential setup.
  • "Account not found": Verify the Account ID is correct and exists in ChatWoot.
  • "Request failed with status code XXX": Indicates an HTTP error; check network connectivity and API endpoint.

Links and References

Discussion