ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions100

Overview

This node allows you to list all users associated with a specific account in ChatWoot, a customer engagement platform. It is useful for automating workflows that require fetching user information from a ChatWoot account, such as synchronizing user data, auditing account members, or integrating with other systems.

Example scenarios:

  • Retrieve all users of an account to send notifications or reports.
  • Sync ChatWoot account users with another CRM or database.
  • Audit account membership for compliance or access control.

Properties

Display Name Type Description Required
Account Id Number The numeric ID of the account Yes
  • Account Id: Enter the numeric identifier of the ChatWoot account whose users you want to list.

Output

The output will be a JSON array where each item represents a user belonging to the specified ChatWoot account. Each user object typically contains fields such as:

  • id: Numeric user ID
  • name: User's name
  • email: User's email address
  • role: User's role within the account
  • ...and other relevant user details as provided by the ChatWoot API.

Note: The exact structure may vary depending on the ChatWoot API response.

Dependencies

  • External Service: Requires access to a ChatWoot instance.
  • API Credentials: You must configure the chatwootApi credentials in n8n, including the base URL and authentication token.
  • n8n Configuration: Ensure the ChatWoot node is installed and properly configured in your n8n environment.

Troubleshooting

  • Missing or Invalid Account Id:
    If the "Account Id" is missing or incorrect, the node may return an error or an empty result. Double-check the account ID value.
  • Authentication Errors:
    If credentials are not set up correctly, you may see errors related to authentication (e.g., "401 Unauthorized"). Verify your API key and base URL in the credentials.
  • Network Issues:
    Connection problems to the ChatWoot server can cause timeouts or network errors. Ensure your n8n instance can reach the ChatWoot API endpoint.

Links and References

Discussion