ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions100

Overview

This node interacts with the ChatWoot API to retrieve automation rules associated with a specific account. It is particularly useful for users who need to programmatically access, audit, or manage automation rules within their ChatWoot accounts. Common scenarios include integrating ChatWoot automation rule data into workflows, reporting, or synchronizing automation configurations across systems.

Example use cases:

  • Fetching all automation rules for an account to display in a dashboard.
  • Auditing automation rules as part of compliance checks.
  • Triggering further actions in n8n based on the presence or configuration of certain automation rules.

Properties

Display Name Type Description
Account Id Number The numeric ID of the account. (Required)
Page Number The page parameter for paginated results.
  • Account Id: Specifies which ChatWoot account's automation rules to fetch.
  • Page: Allows pagination through multiple pages of automation rules.

Output

The output will be a JSON object (or array of objects) representing the automation rules for the specified account and page. Each object typically contains details about an automation rule, such as its ID, name, conditions, and actions. The exact structure depends on the ChatWoot API response, but you can expect fields like:

[
  {
    "id": 123,
    "name": "Auto Assign",
    "description": "Assigns tickets automatically",
    "actions": [...],
    "conditions": [...],
    // ...other fields
  }
]

No binary data is produced by this operation.

Dependencies

  • External Service: Requires access to the ChatWoot API.
  • API Credentials: You must configure the chatwootApi credential in n8n, including the base URL (url) and authentication details.
  • n8n Configuration: Ensure that the ChatWoot node is installed and properly configured in your n8n instance.

Troubleshooting

Common Issues:

  • Invalid Account Id: If the provided Account Id does not exist or is incorrect, the API may return a 404 error or an empty result set.
  • Authentication Errors: Missing or invalid credentials will result in authentication errors (e.g., 401 Unauthorized).
  • Pagination Issues: If the requested page number exceeds available pages, the response may be empty.

Error Messages and Resolutions:

  • "401 Unauthorized": Check your ChatWoot API credentials in n8n.
  • "404 Not Found": Verify the Account Id is correct and exists in ChatWoot.
  • "400 Bad Request": Ensure all required parameters are provided and valid.

Links and References

Discussion