ChatWoot

Overview

The Get Inbox operation for the Inboxes resource in this custom n8n node allows users to retrieve detailed information about a specific inbox from the ChatWoot platform. This is useful in scenarios where you need to fetch configuration or status details of an inbox, such as when automating support workflows, synchronizing inbox data with other systems, or monitoring inbox activity.

Practical examples:

• Fetching inbox details to display in dashboards.
• Using inbox metadata to route messages or automate ticket assignments.
• Auditing or reporting on inbox configurations across multiple accounts.

Properties

Output

The output will be a JSON object containing the details of the requested inbox. While the exact structure depends on the ChatWoot API, typical fields may include:

{
  "id": 123,
  "name": "Support Inbox",
  "channel_type": "Channel::Email",
  "account_id": 456,
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-02T12:00:00Z",
  // ...other inbox-specific fields
}

• The output does not contain binary data; it is strictly JSON.

Dependencies

• External Service: Requires access to a ChatWoot instance.
• API Credentials: Needs valid chatwootApi credentials configured in n8n, including the base URL and authentication token.
• n8n Configuration: Ensure the ChatWoot node is properly installed and credentials are set up in your n8n instance.

Troubleshooting

Common Issues:

• Invalid Account Id or Inbox Id: If either ID is incorrect or does not exist, the node may return a "Not Found" error.
• Authentication Errors: Missing or invalid API credentials will result in authentication failures.
• Network Issues: Connectivity problems between n8n and the ChatWoot server can cause timeouts or connection errors.

Error Messages & Resolutions:

• "401 Unauthorized": Check that your API credentials are correct and have sufficient permissions.
• "404 Not Found": Verify that both the Account Id and Inbox Id are correct and exist in ChatWoot.
• "Connection refused" or "Timeout": Ensure the ChatWoot server URL is reachable from your n8n instance.

Links and References

• ChatWoot API Documentation
• n8n Documentation: Creating Custom Nodes
• ChatWoot Official Website