ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions100

Overview

This node allows you to update an existing team in ChatWoot via its API. It is useful for automating the management of teams, such as renaming a team, updating its description, or changing assignment settings. Typical scenarios include synchronizing team data from another system, bulk-updating team properties, or integrating team management into broader workflows.

Example use cases:

  • Automatically update team names and descriptions based on changes in your HR system.
  • Enable or disable auto-assignment for specific teams as part of onboarding/offboarding processes.
  • Batch-update multiple teams' settings during organizational restructuring.

Properties

Display Name Type Description
Account Id Number The numeric ID of the account. Required to identify which account the team belongs to.
Team Id Number The ID of the team to be updated. Required to specify which team will be modified.
Name String The new name for the team.
Description String The new description for the team.
Allow Auto Assign Boolean If enabled, the system will automatically assign conversations to agents in the team when assigning to a team.

Output

The output will contain the updated team's information in the json field. The structure typically includes:

{
  "id": <number>,
  "name": "<string>",
  "description": "<string>",
  "allow_auto_assign": <boolean>,
  // ...other team fields as returned by the ChatWoot API
}

The exact fields depend on the ChatWoot API's response for the "Update A Team" operation.

Dependencies

  • External Service: Requires access to a ChatWoot instance with API enabled.
  • API Credentials: You must configure the chatwootApi credential in n8n, including the base URL (url) and authentication details.
  • n8n Configuration: Ensure that the node has access to the necessary credentials and that the ChatWoot API endpoint is reachable from your n8n environment.

Troubleshooting

Common Issues:

  • Invalid Account or Team ID: If the provided Account Id or Team Id does not exist, the API will return an error. Double-check these values.
  • Missing Required Fields: Both Account Id and Team Id are required. Omitting them will result in validation errors.
  • Authentication Errors: Incorrect or missing API credentials will cause authentication failures.
  • Network Issues: If n8n cannot reach the ChatWoot API (e.g., due to firewall or DNS issues), requests will fail.

Error Messages:

  • "Account not found" or "Team not found": Check that the IDs are correct and that your credentials have access to the specified resources.
  • "Unauthorized": Verify your API credentials and permissions.
  • "Validation failed": Ensure all required fields are filled and formatted correctly.

Links and References

Discussion