Chatwoot icon

Chatwoot

Interact with Chatwoot API

Overview

This node interacts with the Chatwoot API to manage teams within a specified account. Specifically, the "Team" resource with the "Get" operation allows users to retrieve detailed information about a particular team by its numeric ID within an account. This is useful for scenarios where you need to fetch team details such as members, roles, or settings programmatically as part of a workflow automation.

Practical examples include:

  • Automatically fetching team details to display in dashboards.
  • Integrating team information into other systems like CRMs or project management tools.
  • Using team data to trigger conditional logic in workflows based on team attributes.

Properties

Name Meaning
Account ID The numeric ID of the account to which the team belongs.
Team ID The numeric ID of the specific team to retrieve information for.
Continue on Fail Whether the node should continue executing subsequent items if this operation fails.

Output

The output contains a JSON object representing the full details of the requested team as returned by the Chatwoot API. This typically includes all team-related metadata such as team name, members, permissions, and other configuration details.

The output structure is:

{
  "json": {
    // Team details object as returned by Chatwoot API
  }
}

No binary data is produced by this operation.

Dependencies

  • Requires an active connection to the Chatwoot API via an API key credential configured in n8n.
  • The base URL for the Chatwoot instance must be set in the credentials.
  • Network access to the Chatwoot API endpoint is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Account ID or Team ID will cause the API request to fail.
    • Network connectivity problems or incorrect base URL configuration can prevent successful API calls.
    • Insufficient permissions on the API key may result in authorization errors.
  • Error messages:

    • "404 Not Found": The specified team or account does not exist. Verify the IDs.
    • "401 Unauthorized" or "403 Forbidden": Authentication failed or insufficient permissions. Check API key validity and scopes.
    • "Request failed" or timeout errors: Network or server issues; verify connectivity and Chatwoot service status.
  • To resolve errors, ensure that the Account ID and Team ID are correct, the API key is valid and has appropriate permissions, and the Chatwoot instance is reachable.

Links and References

Discussion