ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Inboxes → Get Inbox

AI-generated

Overview

This node interacts with the ChatWoot API to retrieve detailed information about a specific inbox within a given account. It is useful in scenarios where you need to programmatically access inbox data, such as fetching inbox details for customer support workflows, analytics, or integration with other systems.

For example, you might use this node to:

  • Retrieve an inbox's configuration and status before processing messages.
  • Display inbox metadata in a dashboard.
  • Automate routing or reporting based on inbox properties.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account to which the inbox belongs. This identifies the scope under which the inbox exists.
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 metadata fields provided by the ChatWoot API for that inbox, such as its name, description, status, creation date, and any other relevant attributes.

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 to authorize requests.
  • The base URL for the ChatWoot instance must be set in the credentials.

Troubleshooting

  • Invalid Account Id or Inbox Id: If the IDs provided do not exist or are incorrect, the API will return an error indicating the resource was not found. Verify the IDs before running the node.
  • Authentication Errors: Missing or invalid API credentials will cause authorization failures. Ensure the API key/token is correctly configured.
  • Network Issues: Connectivity problems to the ChatWoot server can cause request timeouts or failures. Check network access and endpoint availability.
  • API Rate Limits: Excessive requests may trigger rate limiting. Implement retries or backoff strategies if needed.

Links and References

Discussion