ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node interacts with the ChatWoot API to retrieve automation rules associated with a specific account. The "Get Account Automation Rule" operation fetches automation rules by specifying the numeric ID of the account and supports pagination through a page parameter. This is useful for users who want to programmatically access or audit automation rules configured in their ChatWoot accounts, such as retrieving rules for reporting, synchronization, or further processing within an n8n workflow.

Practical examples:

  • Fetching all automation rules for a customer support account to analyze rule configurations.
  • Integrating ChatWoot automation rules data into a dashboard or CRM system.
  • Automating audits or backups of automation rules periodically.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account whose automation rules you want to retrieve.
Page The page number for paginated results when fetching automation rules (default is 1).

Output

The node outputs JSON data representing the automation rules retrieved from the specified account. The structure typically includes details about each automation rule such as its conditions, actions, status, and metadata as provided by the ChatWoot API.

If the API supports binary data for this operation (not indicated here), it would be summarized accordingly, but based on the code and operation, output is JSON only.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The base URL for the ChatWoot instance must be configured in the credentials.
  • The node depends on the @devlikeapro/n8n-openapi-node package for OpenAPI integration.
  • The OpenAPI specification (openapi.json) defines the available operations and properties.

Troubleshooting

  • Invalid Account Id: If the account ID is incorrect or does not exist, the API will likely return an error or empty result. Verify the account ID before running the node.
  • Authentication Errors: Ensure that the API key credential is valid and has sufficient permissions to access automation rules.
  • Pagination Issues: If there are many automation rules, use the Page property to paginate through results. Omitting or setting an invalid page number may cause incomplete data retrieval.
  • Network or API Endpoint Errors: Confirm that the base URL in credentials is correct and reachable.

Links and References

Discussion