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 for an account by its numeric ID, supporting pagination through a page parameter. This is useful in scenarios where you want to programmatically access or audit automation rules configured in ChatWoot accounts, such as integrating rule data into dashboards, reports, or other workflow automations.

Practical examples:

  • Fetching all automation rules of a customer support account to analyze their configurations.
  • Integrating automation rule details into a CRM system for enhanced customer interaction tracking.
  • Periodically retrieving automation rules to monitor changes or updates.

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 rule conditions, actions, and metadata. The output does not include binary data.

Example output JSON structure (simplified):

{
  "automation_rules": [
    {
      "id": 123,
      "name": "Rule Name",
      "conditions": [...],
      "actions": [...],
      "created_at": "2023-01-01T00:00:00Z",
      ...
    },
    ...
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 5,
    ...
  }
}

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The node expects the base URL of the ChatWoot instance to be configured in the credentials.
  • No additional external dependencies beyond the ChatWoot API and n8n's HTTP request capabilities.

Troubleshooting

  • Common issues:

    • Invalid or missing account ID will result in errors or empty responses.
    • Incorrect API credentials or base URL configuration can cause authentication failures.
    • Pagination parameters out of range may return empty results or errors.
  • Error messages and resolutions:

    • 401 Unauthorized: Check that the API key credential is correctly set and has necessary permissions.
    • 404 Not Found: Verify the account ID exists and is accessible with the provided credentials.
    • 400 Bad Request: Ensure the page parameter is a positive integer and within valid range.

Links and References

Discussion