Chatwoot icon

Chatwoot

Interact with Chatwoot API

Actions35

Overview

This node interacts with the Chatwoot API to manage teams within a specified account. Specifically, the "Team" resource with the "Get Many" operation retrieves a list of all teams associated with a given account ID.

Use cases include:

  • Fetching all teams in an account to display or process team data.
  • Automating workflows that require knowledge of team structures or memberships.
  • Integrating Chatwoot team data into other systems for reporting or synchronization.

Example: You want to get a list of all support teams in your Chatwoot account to assign conversations dynamically based on team availability.

Properties

Name Meaning
Account ID The numeric ID of the Chatwoot account whose teams you want to retrieve. This is required.
Continue on Fail Whether the node should continue executing subsequent items if this operation fails (boolean).

Output

The output is an array of JSON objects, each representing a team retrieved from the Chatwoot API. Each object contains the full team details as returned by the API under the json property.

Example output structure (simplified):

[
  {
    "json": {
      "id": 123,
      "name": "Support Team",
      "description": "Handles customer support",
      "created_at": "2023-01-01T12:00:00Z",
      ...
    }
  },
  {
    "json": {
      "id": 124,
      "name": "Sales Team",
      "description": "Handles sales inquiries",
      "created_at": "2023-01-02T12:00:00Z",
      ...
    }
  }
]

No binary data is output by this operation.

Dependencies

  • Requires an API key credential configured in n8n to authenticate requests to the Chatwoot API.
  • The base URL for the Chatwoot instance must be set in the credentials.
  • The node makes HTTP GET requests to the endpoint /api/v1/accounts/{accountId}/teams.

Troubleshooting

  • Common issues:

    • Invalid or missing Account ID will cause the API request to fail.
    • Incorrect or expired API authentication token will result in authorization errors.
    • Network connectivity issues can prevent successful API calls.

  • Error messages:

    • "error": "Unauthorized": Check that the API key credential is valid and has proper permissions.
    • "error": "Not Found": Verify the Account ID exists and is accessible by the API key.
    • Timeout or network errors: Ensure the Chatwoot server is reachable from n8n.

  • Resolution tips:

    • Double-check the Account ID input.
    • Confirm API credentials are correctly configured and active.
    • Enable "Continue on Fail" if you want the workflow to proceed despite occasional failures.

Links and References

Discussion