ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node enables the creation of a new inbox within an account on the ChatWoot platform. It is useful for automating the setup of communication channels where messages from customers or users can be received and managed. Typical use cases include setting up dedicated inboxes for different departments, projects, or brands to streamline customer support workflows.

For example, a company could use this node to programmatically create inboxes for new product lines or regional offices, ensuring that incoming messages are properly routed without manual configuration.

Properties

Name Meaning
Account Id The numeric identifier of the 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 associated with the inbox.
Channel A JSON object defining the channel configuration details for the inbox (e.g., type).

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 configuration, timestamps, and other metadata related to the inbox.

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to the ChatWoot API.
  • Needs an API authentication token configured in the node credentials.
  • The base URL for the ChatWoot instance must be set in the credentials.
  • The node uses standard HTTP headers for JSON content negotiation.

Troubleshooting

  • Invalid Account Id: If the provided account ID does not exist or the API key lacks permission, the node will fail. Verify the account ID and ensure the API key has appropriate access rights.
  • Malformed Channel JSON: The channel property expects valid JSON. Invalid JSON syntax will cause errors. Use proper JSON formatting.
  • Missing Required Fields: The Account Id is mandatory. Omitting it will result in an error.
  • API Connectivity Issues: Network problems or incorrect base URL settings can prevent successful API calls. Confirm network connectivity and correct URL configuration.
  • Avatar Upload Failures: If the avatar file path or URL is invalid or inaccessible, the avatar may not be set correctly.

Links and References

Discussion