ChatWootInstall

Overview

This node allows users to create a custom filter in the ChatWoot system. Custom filters help segment or organize data such as conversations, contacts, or reports based on specific criteria defined by the user. This is particularly useful for automating workflows, reporting, or managing large datasets by applying reusable filters.

For example, a support team might create a custom filter to view only conversations related to high-priority customers or to generate reports filtered by certain contact attributes.

Properties

Output

The node outputs JSON data representing the newly created custom filter object as returned by the ChatWoot API. This typically includes details such as the filter's ID, name, type, query parameters, and associated account information.

No binary data output is involved.

Dependencies

• Requires an API key credential for authenticating with the ChatWoot API.
• The base URL for the ChatWoot instance must be configured in the node credentials.
• The node uses the ChatWoot REST API endpoint to create custom filters.

Troubleshooting

• Invalid Account Id: Ensure the provided account ID exists and the API key has access to it.
• Malformed Query JSON: The Query property must be valid JSON; otherwise, the API call will fail.
• Permission Errors: The API key must have permissions to create filters on the specified account.
• Filter Type/Type Mismatch: Both Filter Type and Type properties should be consistent and valid options (conversation, contact, report).
• API Connectivity Issues: Verify network connectivity and correct base URL configuration.

Common error messages usually come from the API response and may indicate invalid input, authentication failure, or permission issues. Reviewing the API response message helps identify the exact cause.

Links and References

• ChatWoot API Documentation
• n8n Documentation - Creating Custom Nodes