ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node interacts with the ChatWoot API to list all users associated with a specific account. It is useful for scenarios where you need to retrieve and manage user information within a ChatWoot account, such as displaying user lists, auditing user access, or integrating user data into other workflows.

For example, you might use this node to fetch all users of a customer support account to synchronize them with an internal CRM system or to generate reports on user activity.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account whose users you want to list

Output

The node outputs JSON data containing the list of users for the specified account. Each user object typically includes details such as user ID, name, email, role, and status within the account.

If the node supports binary data output (not indicated here), it would represent any file or media content related to users, but in this case, the output is purely JSON-based user data.

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 ID being valid.

Troubleshooting

  • Invalid Account Id: If the account ID is incorrect or does not exist, the API will likely return an error or empty result. Verify the account ID before running the node.
  • Authentication Errors: Ensure that the API key credential is correctly set up and has sufficient permissions to access user data.
  • Network Issues: Connectivity problems to the ChatWoot server can cause request failures. Check network settings and endpoint availability.
  • API Rate Limits: Excessive requests may lead to rate limiting by the ChatWoot API. Implement retry logic or reduce request frequency if needed.

Links and References

Discussion