ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node operation lists all labels associated with a specific conversation within an account on the ChatWoot platform. It is useful for retrieving metadata tags or categorizations applied to conversations, which can help in organizing, filtering, or analyzing customer interactions.

Practical examples include:

  • Fetching all labels of a conversation to display them in a dashboard.
  • Automating workflows based on conversation labels (e.g., routing conversations tagged as "urgent" to a priority queue).
  • Auditing or reporting on conversation labels for quality control or analytics.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account where the conversation exists.
Conversation Id The numeric ID of the specific conversation whose labels you want to list.

Output

The output JSON contains an array of label objects associated with the specified conversation. Each label object typically includes details such as label name, color, and ID, representing the metadata tags assigned to that conversation.

No binary data output is expected from this operation.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The node expects the base URL of the ChatWoot instance to be configured in the credentials.
  • Internet access to communicate with the ChatWoot API endpoint.

Troubleshooting

  • Invalid Account or Conversation ID: If the provided IDs do not exist or are incorrect, the API may return errors or empty results. Verify the IDs before running the node.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to access conversation labels.
  • Network Issues: Connectivity problems can cause request failures; check network settings and ChatWoot server availability.
  • API Rate Limits: Excessive requests might lead to rate limiting; implement retries or backoff strategies if needed.

Links and References

  • ChatWoot API Documentation - Official API docs for reference on endpoints and data structures related to conversations and labels.

Discussion