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 team in ChatWoot to synchronize them with an internal directory or to generate reports on user activity.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account for which to list all users

Output

The node outputs JSON data containing the list of users for the specified account. Each item in the output corresponds to a user object retrieved from the ChatWoot API, typically including user details such as user ID, name, email, role, and status.

If the API supports it, the output may also include pagination metadata or additional user-related information.

No binary data output is expected from this operation.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The node expects the base URL of the ChatWoot instance to be configured in the credentials.
  • Internet connectivity to reach the ChatWoot API endpoint.

Troubleshooting

  • Invalid Account Id: If the provided account ID does not exist or is incorrect, 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 valid and has sufficient permissions to access user data.
  • Network Issues: Connectivity problems can cause request failures. Check network settings and firewall rules.
  • API Rate Limits: If many requests are made in a short time, the API might throttle requests. Implement retry logic or reduce request frequency if needed.

Links and References

Discussion