ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions100

Overview

This node interacts with the ChatWoot API to list all labels associated with a specific conversation. It is useful in scenarios where you need to retrieve organizational tags or categories applied to a conversation, for example, to automate workflows based on label presence, generate reports, or trigger actions depending on conversation categorization.

Practical examples:

  • Fetching all labels of a support ticket to route it to the appropriate team.
  • Auditing conversations by their assigned labels for analytics.
  • Triggering follow-up actions if certain labels are present on a conversation.

Properties

Display Name Type Description
Account Id Number The numeric ID of the ChatWoot account. Required to specify which account's conversation is being queried.
Conversation Id Number The numeric ID of the conversation whose labels you want to list.

Output

The output will be a JSON array containing the labels associated with the specified conversation. Each item in the array represents a label and typically includes at least the label name. The exact structure may depend on the ChatWoot API, but a typical response might look like:

[
  {
    "id": 123,
    "title": "urgent",
    "color": "#FF0000"
  },
  {
    "id": 124,
    "title": "billing",
    "color": "#00FF00"
  }
]
  • id: Numeric identifier of the label.
  • title: The name of the label.
  • color: (Optional) Color code associated with the label.

Dependencies

  • External Service: Requires access to a ChatWoot instance.
  • API Credentials: Needs a valid chatwootApi credential configured in n8n, including the base URL (url) and authentication details.
  • n8n Configuration: Ensure the credentials are set up under n8n’s credentials section as chatwootApi.

Troubleshooting

Common Issues:

  • Invalid Account Id or Conversation Id: If either ID is incorrect or does not exist, the node may return an error or an empty result.
  • Authentication Errors: Missing or invalid API credentials will cause authentication failures.
  • Insufficient Permissions: The API key used must have permission to view conversations and their labels.

Error Messages & Resolutions:

  • "401 Unauthorized": Check your API credentials and ensure they are correct and active.
  • "404 Not Found": Verify that both the Account Id and Conversation Id are correct and exist in your ChatWoot instance.
  • "403 Forbidden": Ensure your API user has sufficient permissions to access the requested resource.

Links and References

Discussion