ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Inboxes → List All Inboxes

AI-generated

Overview

This node interacts with the ChatWoot API to list all inboxes associated with a specified account. It is useful for scenarios where you need to retrieve and manage multiple inboxes within a ChatWoot account, such as displaying them in a dashboard, syncing inbox data, or automating workflows based on inbox information.

For example, a user might use this node to fetch all inboxes of their customer support accounts to monitor message traffic or to integrate inbox details into a CRM system.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account for which to list all inboxes

Output

The node outputs JSON data representing the list of inboxes retrieved from the ChatWoot API for the given account. Each item in the output typically contains details about an individual inbox, such as its ID, name, description, and other metadata provided by the API.

If the API supports binary data related to inboxes (e.g., attachments), the node would handle it accordingly, but based on the provided code and operation, the primary output is JSON data listing inboxes.

Dependencies

  • Requires an active connection to the ChatWoot API.
  • Needs an API authentication token or key configured in the node’s credentials to authorize requests.
  • The base URL for the ChatWoot instance must be set in the credentials configuration.

Troubleshooting

  • Common Issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Providing an incorrect or non-existent Account Id may result in empty results or errors.
    • Network connectivity issues can prevent the node from reaching the ChatWoot API.
  • Error Messages:

    • Authentication errors typically indicate invalid API keys or tokens; verify and update credentials.
    • "Account not found" or similar messages suggest the Account Id does not exist or is inaccessible.
    • Timeout or network errors require checking internet connectivity and API endpoint availability.

Links and References

Discussion