ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node interacts with the ChatWoot API to retrieve detailed information about a specific inbox within a given account. It is useful when you need to programmatically access inbox data such as its configuration, status, or metadata in workflows that manage customer conversations or automate support processes.

A practical example would be fetching an inbox's details before routing incoming messages or analyzing inbox settings for reporting purposes.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account where the inbox resides. This identifies the account context for the inbox.
Id The numeric ID of the specific inbox to retrieve.

Output

The node outputs JSON data representing the full details of the requested inbox. This typically includes all properties returned by the ChatWoot API for an inbox, such as its name, description, status, and any other metadata associated with it.

No binary data output is expected from this operation.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The base URL for the ChatWoot instance must be configured in the node credentials.
  • The node depends on the ChatWoot REST API being accessible and the provided account and inbox IDs being valid.

Troubleshooting

  • Invalid Credentials or URL: If authentication fails, verify that the API key and base URL are correctly set in the node credentials.
  • Resource Not Found: Errors indicating the inbox or account does not exist usually mean the provided IDs are incorrect or the user lacks permission.
  • Network Issues: Timeouts or connection errors suggest network problems or that the ChatWoot server is unreachable.
  • Missing Required Parameters: Ensure both Account Id and Inbox Id are provided and are valid numbers.

Links and References

Discussion