Chatwoot

Overview

This node integrates with the Chatwoot API, enabling users to manage various Chatwoot resources such as accounts, contacts, conversations, messages, inboxes, canned responses, webhooks, teams, and labels. It supports a wide range of operations including creating, retrieving, updating, deleting, filtering, and searching these resources.

Common scenarios where this node is beneficial include:

• Automating customer support workflows by managing conversations and messages.
• Synchronizing contact information between Chatwoot and other systems.
• Managing canned responses and webhooks for efficient communication.
• Organizing teams, inboxes, and labels to streamline support operations.

For example, a user can create a new contact in Chatwoot when a lead is captured in a CRM, or fetch all open conversations assigned to a specific team to generate reports.

Properties

Note: The node also requires selecting a Resource and an Operation, but since the request was limited to the "Default" resource and operation, only the "Continue on Fail" property is listed here.

Output

The node outputs JSON data representing the result of the performed operation. The structure depends on the resource and operation:

• For single-item retrievals (e.g., get a contact), the output is a JSON object with the resource's details.
• For list retrievals (e.g., get many contacts), the output is an array of JSON objects, each representing one item.
• For create, update, and delete operations, the output typically contains the updated resource data or a success confirmation.
• In case of deletion, the output JSON includes { "success": true }.
• If "Continue on Fail" is enabled and an error occurs, the output will contain an error message in the JSON under the error key.

The node does not output binary data.

Dependencies

• Requires an API key credential for authenticating with the Chatwoot API.
• Needs the base URL of the Chatwoot instance configured in credentials.
• Uses HTTP requests to interact with Chatwoot's REST API endpoints.

Troubleshooting

• Common issues:

  • Invalid or missing API credentials will cause authentication failures.
  • Providing incorrect IDs (e.g., accountId, contactId) will result in "not found" errors.
  • Network connectivity problems may cause request timeouts or failures.
  • Improperly formatted input data (e.g., missing required fields) can cause validation errors from the API.

• Error messages:

  • Errors thrown by the API are surfaced as exceptions unless "Continue on Fail" is enabled.
  • When "Continue on Fail" is true, errors are returned as JSON objects with an error field containing the error message.

• Resolution tips:

  • Verify that the API key and base URL are correctly set up.
  • Double-check all required parameters for the selected resource and operation.
  • Use the "Continue on Fail" option during testing to handle partial failures gracefully.
  • Consult Chatwoot API documentation for detailed error explanations.

Links and References

• Chatwoot API Documentation
• n8n Documentation on HTTP Request Node
• n8n Expressions Guide (useful for dynamic parameter values)