ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node interacts with the ChatWoot API to update the agents assigned to a specific team within an account. It allows users to add multiple agents (users) to a team by specifying their user IDs. This is useful for managing team memberships dynamically, such as when onboarding new support agents or reorganizing teams in a customer support platform.

Practical examples:

  • Adding newly hired support agents to an existing team.
  • Reassigning agents to different teams based on workload or expertise.
  • Automating team updates as part of a larger workflow that manages user roles and permissions.

Properties

Name Meaning
Account Id The numeric ID of the account where the team exists.
Team Id The numeric ID of the team to which agents will be added.
User Ids A JSON array containing the IDs of users (agents) to be added to the specified team.

Output

The node outputs JSON data representing the response from the ChatWoot API after updating the team's agents. This typically includes confirmation of the updated team details and the list of agents now assigned to the team.

No binary data output is involved.

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 @devlikeapro/n8n-openapi-node package for OpenAPI integration.

Troubleshooting

  • Invalid Account or Team ID: If the provided account or team ID does not exist, the API will return an error. Verify these IDs before running the node.
  • Malformed User IDs JSON: The User Ids property expects a valid JSON array. Ensure the input is correctly formatted JSON; otherwise, parsing errors will occur.
  • Authentication Errors: If the API key or base URL is incorrect or missing, authentication will fail. Check the credential configuration.
  • API Rate Limits: Frequent updates may hit API rate limits imposed by ChatWoot. Implement retries or delays if necessary.

Links and References

Discussion