ChatWoot

Overview

The Conversation Filter operation for the Conversations resource in this custom n8n node allows users to filter and retrieve conversations from a ChatWoot account based on specific criteria. This is particularly useful for support teams or administrators who need to segment conversations by attributes such as language, status, or other metadata. For example, you can use this node to fetch all pending conversations where the browser language is not English.

Properties

Details

• Account Id:
  • Type: Number
  • Required: Yes
  • Description: The unique identifier for your ChatWoot account.
• Page:
  • Type: Number
  • Default: 0
  • Description: Used for pagination; specifies which page of results to return.
• Payload:
  • Type: JSON
  • Default Example:

    [
      {
        "attribute_key": "browser_language",
        "filter_operator": "not_eq",
        "values": ["en"],
        "query_operator": "AND"
      },
      {
        "attribute_key": "status",
        "filter_operator": "eq",
        "values": ["pending"],
        "query_operator": null
      }
    ]
    

  • Description: Defines the filtering logic. Each object specifies an attribute to filter by, the operator, values, and how it combines with other filters.

Output

• json:
  The output will be a JSON object containing the filtered list of conversations matching the specified criteria. The structure typically includes conversation details such as IDs, statuses, participants, timestamps, and any other relevant metadata provided by the ChatWoot API.

• Binary:
  This node does not output binary data.

Dependencies

• External Service: Requires access to a ChatWoot instance.
• API Key/Credentials: Needs valid ChatWoot API credentials configured in n8n under the name chatwootApi.
• Environment Variables: The base URL for the ChatWoot instance must be set in the credentials (url field).

Troubleshooting

• Common Issues:

  • Invalid Account Id: If the provided Account Id does not exist or is incorrect, the node may return an error or empty results.
  • Malformed Payload: If the payload JSON is invalid or does not match the expected schema, the request may fail.
  • Authentication Errors: Missing or incorrect API credentials will result in authentication failures.
  • Pagination Issues: Requesting a page number beyond available pages will return empty results.

• Error Messages & Resolutions:

  • "401 Unauthorized": Check that your API credentials are correct and have sufficient permissions.
  • "400 Bad Request": Ensure the payload is valid JSON and matches the expected filter format.
  • "404 Not Found": Verify the Account Id and endpoint URL.

Links and References

• ChatWoot API Documentation
• n8n Documentation: Custom Nodes
• Filtering Conversations in ChatWoot