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 whenever a new message 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 like "support".
Conditions JSON array specifying 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 returned by the ChatWoot API. This typically includes details such as the rule’s ID, name, description, active status, event name, conditions, and actions after the update.

If the API supports binary data output, it is not indicated here; thus, the output is purely JSON structured data describing the updated automation rule.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The base URL for the ChatWoot instance must be configured in the node credentials.
  • The node uses the ChatWoot REST API endpoint for updating automation rules within an account.

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 properties expect valid JSON arrays. Invalid JSON will cause parsing errors.
  • Insufficient Permissions: The API key used must have permissions to update automation rules in the specified account.
  • API Connectivity Issues: Verify network connectivity and correct base URL configuration.
  • Event Name Not Supported: Use only the supported event names listed in the options; otherwise, the API may reject the request.

Links and References

Discussion