ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node updates an existing automation rule within a specified account in ChatWoot. Automation rules allow users to define event-driven actions that automatically execute when certain conditions are met, such as labeling messages or triggering workflows based on message content or conversation events.

Common scenarios include:

  • Automatically tagging incoming messages containing specific keywords (e.g., "help") with labels like "support" or "sales".
  • Enabling or disabling automation rules dynamically.
  • Updating the description or name of an automation rule to reflect changes in business logic.

Practical example:
You want to update an automation rule that adds a "support" label to any message created event where the message content contains the word "help". This node lets you modify the rule’s name, description, active status, event trigger, conditions, and actions accordingly.

Properties

Name Meaning
Account Id The numeric ID of the account where the automation rule exists.
Id The unique identifier of the automation rule to be updated.
Name The name of the automation rule.
Description A textual description explaining what the automation rule does and its associated actions.
Event Name The event that triggers the automation rule. Options: Conversation Created, Conversation Updated, Message Created.
Active Boolean flag to enable or disable the automation rule.
Actions JSON array defining the actions to perform when conditions match. Example action: adding a label.
Conditions JSON array defining the conditions under which the automation rule triggers. Example condition: message content contains "help".

Output

The node outputs JSON data representing the updated automation rule object as returned by the ChatWoot API. This typically includes all properties of the automation rule such as its id, name, description, event name, active status, conditions, and actions.

If binary data is involved (not indicated here), it would represent attachments or media related to the automation rule, but this node focuses on JSON data only.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • Needs the base URL of the ChatWoot instance configured in the credentials.
  • The node uses the ChatWoot REST API endpoint to update automation rules.

Troubleshooting

  • Invalid Account Id or Rule Id: Ensure the provided numeric IDs exist and belong to your ChatWoot instance.
  • Malformed JSON in Actions or Conditions: The actions and conditions fields expect valid JSON arrays. Invalid JSON will cause errors. Use proper JSON formatting.
  • Permission Errors: The API key must have sufficient permissions to update automation rules.
  • Event Name Not Supported: Only the listed event names are valid; using unsupported events will result in errors.
  • API Connectivity Issues: Verify network connectivity and correct base URL configuration.

Links and References

Discussion