ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Inbox API → Get Details Of A Inbox

AI-generated

Overview

This node interacts with the Inbox API of a chat or messaging platform to retrieve detailed information about a specific inbox. It is useful when you need to fetch metadata or status details of an inbox channel identified by a unique identifier. For example, it can be used in customer support workflows to get the current state or configuration of a particular inbox before processing messages or routing conversations.

Properties

Name Meaning
Inbox Identifier The unique identifier of the inbox channel obtained from the API. This is required to specify which inbox's details to retrieve.

Output

The node outputs JSON data containing the detailed information of the specified inbox. This typically includes all relevant metadata and properties associated with that inbox as returned by the API. There is no indication that binary data is output by this node.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The base URL for the API must be configured in the node credentials.
  • The node depends on the @devlikeapro/n8n-openapi-node package for OpenAPI integration.

Troubleshooting

  • Missing or invalid Inbox Identifier: Ensure the "Inbox Identifier" property is provided and correctly matches an existing inbox ID.
  • Authentication errors: Verify that the API key credential is valid and has sufficient permissions to access inbox details.
  • Network or API endpoint issues: Confirm the base URL is correct and the API service is reachable.
  • Unexpected API response: Check if the API schema has changed or if the inbox ID corresponds to a deleted or inaccessible inbox.

Links and References

Discussion