ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node enables the creation of new inboxes within a specified account in ChatWoot, a customer messaging platform. It is useful for automating the setup of communication channels where messages from customers can be received and managed. Typical use cases include programmatically adding inboxes for different departments, teams, or product lines to organize incoming conversations efficiently.

For example, a company might use this node to create separate inboxes for sales, support, and marketing, each with its own name, avatar image, and channel configuration.

Properties

Name Meaning
Account Id The numeric identifier of the ChatWoot account under which the inbox will be created.
Name The display name of the inbox to be created.
Avatar A file path or URL representing the avatar image for the inbox.
Channel JSON object defining the channel configuration details for the inbox (e.g., type, source).

Output

The node outputs JSON data representing the newly created inbox object as returned by the ChatWoot API. This typically includes details such as the inbox ID, name, avatar URL, channel information, timestamps, and other metadata related to the inbox.

If the node supports binary data output (not indicated here), it would generally relate to files such as avatar images, but based on the provided code and properties, the output is purely JSON.

Dependencies

  • Requires an active ChatWoot account and API access.
  • Needs an API authentication token configured in n8n credentials to authorize requests.
  • The base URL for the ChatWoot instance must be set in the credentials.
  • The node uses the ChatWoot REST API endpoint for inbox creation.

Troubleshooting

  • Missing or invalid Account Id: Ensure the Account Id is correct and corresponds to an existing ChatWoot account; otherwise, the API will reject the request.
  • Invalid JSON in Channel property: The Channel field expects valid JSON. Malformed JSON will cause parsing errors before sending the request.
  • Authentication errors: Verify that the API key/token is correctly configured and has sufficient permissions to create inboxes.
  • Network or connectivity issues: Confirm that the ChatWoot instance URL is reachable from the n8n environment.
  • API rate limits or quota exceeded: If too many requests are made in a short time, the API may throttle requests; handle retries accordingly.

Links and References

Discussion