ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node interacts with the ChatWoot API to retrieve members of a specific inbox within an account. It is useful for scenarios where you need to programmatically access and manage the list of users or agents assigned to handle conversations in a particular inbox. For example, a support team lead might use this node to fetch all members of a customer support inbox to audit or update their roles.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account that owns the inbox.
Inbox Id The numeric ID of the specific inbox whose members you want to retrieve.

Output

The node outputs JSON data representing the members of the specified inbox. This typically includes details such as user IDs, names, roles, and other relevant member information associated with the inbox. There is no binary output.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The base URL for the ChatWoot instance must be configured in the node credentials.
  • The node depends on the ChatWoot REST API being accessible and the provided account and inbox IDs being valid.

Troubleshooting

  • Invalid Account or Inbox ID: If the provided IDs do not exist or are incorrect, the API will return an error. Verify the IDs before running the node.
  • Authentication Errors: Ensure the API key credential is correctly set up and has sufficient permissions to access inbox members.
  • Network Issues: Connectivity problems to the ChatWoot server can cause failures; check network settings and endpoint availability.
  • API Rate Limits: Excessive requests may trigger rate limiting; consider adding delays or retries if needed.

Links and References

Discussion