ChatWootInstall

Overview

This node updates an existing inbox in the ChatWoot system. It allows users to modify various properties of an inbox such as its name, avatar image, auto-assignment settings, and channel configuration. This is useful for managing communication channels dynamically, for example, when rebranding or reorganizing support inboxes, or adjusting routing rules for incoming messages.

Practical examples:

• Renaming an inbox to reflect a new product line.
• Enabling or disabling automatic assignment of conversations to agents.
• Updating the avatar image associated with the inbox.
• Changing the channel configuration details (e.g., switching from email to social media integration).

Properties

Output

The node outputs JSON data representing the updated inbox object returned by the ChatWoot API. This typically includes all current properties of the inbox after the update, such as its ID, name, avatar URL, auto-assignment status, and channel configuration.

No binary data output is involved.

Dependencies

• Requires an API key credential for authenticating with the ChatWoot API.
• Needs the base URL of the ChatWoot instance configured in the credentials.
• Depends on the ChatWoot REST API being accessible and operational.

Troubleshooting

• Invalid Account or Inbox ID: If the provided account or inbox ID does not exist, the API will return an error. Verify that the IDs are correct.
• Authentication Errors: Ensure the API key credential is valid and has sufficient permissions.
• Malformed Channel JSON: The channel property expects valid JSON. Invalid JSON syntax will cause request failures.
• Missing Required Fields: account_id, id, and enable_auto_assignment are required. Omitting these will result in errors.
• Network Issues: Connectivity problems to the ChatWoot server will prevent updates.

Links and References

• ChatWoot API Documentation
• n8n Documentation - Creating Custom Nodes