ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node integrates with the ChatWoot API to add labels to a specific conversation within an account. It is useful for categorizing or tagging conversations automatically based on certain criteria, which helps in organizing and filtering conversations in customer support workflows.

Practical examples include:

  • Automatically tagging conversations that mention specific keywords.
  • Adding priority labels to conversations from VIP customers.
  • Categorizing conversations by issue type for reporting purposes.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account where the conversation exists.
Conversation Id The numeric ID of the conversation to which labels will be added.
Labels An array of label strings to add to the conversation. These are comma-separated strings.

Output

The node outputs JSON data representing the response from the ChatWoot API after adding the labels to the conversation. This typically includes confirmation of the updated conversation details, including the newly added labels.

If the API supports it, binary data output is not expected for this operation.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The base URL of the ChatWoot instance must be configured in the node credentials.
  • The node depends on the ChatWoot REST API being accessible and the user having appropriate permissions to modify conversations.

Troubleshooting

  • Invalid Account or Conversation ID: If the provided IDs do not exist or the user lacks access, the API will return an error. Verify the IDs and permissions.
  • Malformed Labels JSON: The labels property expects a valid JSON array of strings. Ensure the input is correctly formatted.
  • Authentication Errors: Missing or invalid API credentials will cause authentication failures. Confirm the API key and base URL are correct.
  • API Rate Limits: Excessive requests may lead to rate limiting. Implement retry logic or reduce request frequency if needed.

Links and References

Discussion