ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions100

Overview

This node interacts with the ChatWoot API to retrieve details of a specific inbox. It is useful in scenarios where you need to fetch metadata or configuration information about an inbox channel within your ChatWoot account, such as for reporting, automation, or integration purposes.

Example use cases:

  • Automatically retrieving inbox details to route messages or tickets.
  • Integrating ChatWoot inbox data into dashboards or other systems.
  • Validating the existence and configuration of an inbox before performing further actions.

Properties

Display Name Type Description Required
Inbox Identifier String The identifier obtained from API inbox channel. Yes

Output

The output will be a JSON object containing the details of the specified inbox. The structure typically includes fields such as the inbox's ID, name, type, and other relevant metadata as provided by the ChatWoot API.

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

Note: The exact fields depend on the ChatWoot API response.

Dependencies

  • External Service: Requires access to a ChatWoot instance with API enabled.
  • API Credentials: Needs a valid chatwootApi credential set up in n8n, including the base URL and authentication token.
  • n8n Configuration: Ensure that the credentials are configured under the name chatwootApi.

Troubleshooting

  • Missing or Invalid Credentials:
    Error Message: "401 Unauthorized" or "Invalid credentials"
    Resolution: Check that the chatwootApi credentials are correctly configured in n8n.

  • Invalid Inbox Identifier:
    Error Message: "404 Not Found" or similar
    Resolution: Verify that the provided Inbox Identifier exists in your ChatWoot account.

  • Network/Connection Issues:
    Error Message: "ENOTFOUND", "ECONNREFUSED", etc.
    Resolution: Ensure that the ChatWoot API endpoint is reachable from your n8n instance.

Links and References

Discussion