ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node updates an existing inbox in a ChatWoot account. It is useful for managing communication channels by modifying inbox details such as the name, avatar image, auto-assignment settings, and channel configuration. Typical use cases include renaming an inbox to reflect new team structures, updating the avatar to match branding changes, enabling or disabling automatic assignment of conversations, or changing the underlying channel settings.

For example, a support team might use this node to update the inbox name from "Support Team A" to "Customer Support" and change the avatar to a new logo image after rebranding.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account where the inbox exists.
Id The unique numeric ID of the inbox to update.
Name The new name for the inbox.
Enable Auto Assignment Boolean flag to enable or disable automatic assignment of conversations to agents.
Avatar URL or base64 string representing the image file to use as the inbox avatar.
Channel JSON object defining the channel configuration associated with the inbox (e.g., type).

Output

The node outputs JSON data representing the updated inbox object as returned by the ChatWoot API. This typically includes fields such as the inbox ID, name, avatar URL, auto-assignment status, channel details, timestamps, and other metadata reflecting the current state of the inbox after the update.

No binary data output is produced by this node.

Dependencies

  • Requires an active ChatWoot account and API access.
  • Needs an API authentication token configured in n8n credentials to authorize requests.
  • The node uses the ChatWoot REST API endpoint specified by the user’s credentials URL.
  • The node depends on the @devlikeapro/n8n-openapi-node package for OpenAPI integration.

Troubleshooting

  • Invalid Account or Inbox ID: If the provided account or inbox ID does not exist or is incorrect, the API will return an error. Verify IDs before running the node.
  • Authentication Errors: Missing or invalid API credentials will cause authorization failures. Ensure the API key/token is correctly set up in n8n.
  • Malformed Channel JSON: The channel property expects valid JSON. Invalid JSON syntax will cause parsing errors. Use proper JSON formatting.
  • Empty Required Fields: Required fields like account_id, id, and enable_auto_assignment must be provided; otherwise, the request will fail.
  • API Rate Limits: Frequent updates may hit ChatWoot API rate limits. Implement retry logic or reduce request frequency if needed.

Links and References

Discussion