Chatwoot icon

Chatwoot

Interact with Chatwoot API

Actions35

Overview

This node interacts with the Chatwoot API to manage various resources such as accounts, contacts, conversations, messages, inboxes, canned responses, webhooks, teams, and labels. Specifically, for the Inbox resource with the Get Many operation, it retrieves a list of inboxes associated with a specified account.

Use cases include:

  • Fetching all inboxes under a particular Chatwoot account to display or process them in workflows.
  • Automating inbox management by integrating inbox data into other systems.
  • Monitoring or reporting on inbox configurations and statuses.

Example: You want to retrieve all inboxes for account ID 123 to synchronize them with your CRM or to analyze message routing setups.

Properties

Name Meaning
Account ID The numeric ID of the Chatwoot account whose inboxes you want to retrieve.
Continue on Fail Whether the node should continue executing subsequent items if this operation fails.

Output

The output is an array of JSON objects, each representing an inbox retrieved from the Chatwoot API. Each inbox object contains details as provided by the API, such as inbox ID, name, description, and other metadata related to the inbox configuration.

The output structure is:

[
  {
    "json": {
      "id": 1,
      "name": "Support Inbox",
      "description": "Main support channel",
      "...": "other inbox properties"
    }
  },
  {
    "json": {
      "id": 2,
      "name": "Sales Inbox",
      "description": "Sales inquiries",
      "...": "other inbox properties"
    }
  }
]

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Chatwoot API.
  • The base URL for the Chatwoot instance must be configured in the credentials.
  • Network access to the Chatwoot API endpoint is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Account ID will cause the API request to fail.
    • Incorrect or expired API credentials will result in authentication errors.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • "Request failed with status code 401": Authentication failure; verify API key and permissions.
    • "Request failed with status code 404": Account ID not found; check that the account exists.
    • "Request failed with status code 500": Server error; try again later or contact Chatwoot support.

  • Resolution tips:

    • Ensure the Account ID is correct and the account exists.
    • Confirm the API key credential is valid and has required scopes.
    • Enable "Continue on Fail" if you want the workflow to proceed despite individual item failures.

Links and References

Discussion