ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions100

Overview

This node interacts with the ChatWoot API to retrieve the list of members belonging to a specific team within an account. It is useful in scenarios where you need to automate workflows involving team management, such as synchronizing team member lists, auditing access, or integrating ChatWoot teams with other systems.

Practical examples:

  • Fetching all members of a support team to assign tasks or tickets.
  • Auditing team composition for compliance or reporting.
  • Integrating team data into HR or project management tools.

Properties

Display Name Type Description
Account Id Number The numeric ID of the account.
Team Id Number The ID of the team whose members are to be listed.

Both properties are required and must be provided to fetch the team members.

Output

The output will be a JSON object (or array of objects) representing the members of the specified team. Each object typically contains details about a team member, such as their user ID, name, email, role, and other relevant attributes as returned by the ChatWoot API.

Example output structure:

[
  {
    "id": 123,
    "name": "Jane Doe",
    "email": "jane@example.com",
    "role": "agent",
    // ...other fields
  },
  // ...more members
]

Dependencies

  • External Service: Requires access to a ChatWoot instance with API enabled.
  • API Credentials: You must configure n8n credentials named chatwootApi, which should include at least the base URL (url) and authentication details for the ChatWoot API.
  • n8n Configuration: Ensure that the ChatWoot node is properly installed and that your n8n instance can reach the ChatWoot server.

Troubleshooting

  • Missing or Invalid Credentials:
    Error message: "401 Unauthorized" or "Invalid credentials."
    Resolution: Check that the chatwootApi credentials are correctly set up in n8n and have sufficient permissions.

  • Incorrect Account Id or Team Id:
    Error message: "404 Not Found" or "Team not found."
    Resolution: Verify that both the Account Id and Team Id are correct and exist in your ChatWoot instance.

  • Network Issues:
    Error message: "ENOTFOUND" or "ECONNREFUSED."
    Resolution: Ensure that the n8n instance can connect to the ChatWoot server (check network/firewall settings).

Links and References

Discussion