ChatWoot

Overview

The "List All Inboxes" operation for the "Inboxes" resource in this custom n8n node allows users to retrieve a list of all inboxes associated with a specific ChatWoot account. This is useful for automating workflows that need to access, display, or process information about available inboxes within a ChatWoot instance. For example, you might use this node to populate dropdowns, synchronize inbox data with other systems, or trigger actions based on the presence or configuration of certain inboxes.

Properties

• Account Id: Enter the numeric identifier for your ChatWoot account. This property determines which account's inboxes will be listed.

Output

The output is a JSON array where each item represents an inbox belonging to the specified account. Each object in the array typically contains fields such as:

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

• id: Unique identifier for the inbox.
• name: Name of the inbox.
• channel_type: The type of channel (e.g., email, web, etc.).
• created_at / updated_at: Timestamps for creation and last update.

Note: The exact structure may include additional fields depending on the ChatWoot API version.

Dependencies

• External Service: Requires access to a ChatWoot instance with API enabled.
• API Credentials: You must configure the chatwootApi credential in n8n, including the base URL and authentication details.
• Environment Variables: None required by default, but ensure your n8n instance can reach the ChatWoot API endpoint.

Troubleshooting

• Invalid Account Id: If the provided Account Id does not exist or is incorrect, the node may return an error or an empty result set. Double-check the Account Id value.
• Authentication Errors: Missing or invalid API credentials will result in authentication errors. Ensure the chatwootApi credential is correctly configured in n8n.
• Network Issues: If n8n cannot connect to the ChatWoot API (due to firewall, DNS, or network issues), the node will fail with a connection error.
• Permission Denied: The API user must have permission to view inboxes for the specified account.

Links and References

• ChatWoot API Documentation – List All Inboxes
• n8n Documentation – Custom Nodes
• ChatWoot Official Website