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.
  • Enabling or disabling automation rules dynamically.
  • Updating the description or name of an automation rule to reflect changes in business logic.

For example, you might update a rule to add a "support" label whenever a new message contains the word "help," helping your support team prioritize inquiries.

Properties

Name Meaning
Account Id The numeric ID of the account where the automation rule exists and will be updated.
Id The unique identifier of the automation rule to update.
Name The new name for the automation rule.
Description A textual description explaining what the automation rule does and its intended actions.
Event Name The event that triggers the automation rule. Options: Conversation Created, Conversation Updated, Message Created.
Active Boolean flag to enable (true) or disable (false) the automation rule.
Actions JSON array defining the actions to perform when conditions match. Example: adding labels like "support".
Conditions JSON array specifying the conditions under which the automation triggers. Example: message content contains "help".

Output

The node outputs JSON data representing the updated automation rule object returned by the ChatWoot API. This typically includes fields such as the rule's ID, name, description, active status, event name, conditions, and actions reflecting the updated state.

No binary data output is involved.

Dependencies

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

Troubleshooting

  • Invalid Account Id or Rule Id: If the provided account or rule ID does not exist, the API will return an error. Verify IDs are correct.
  • Malformed JSON in Actions or Conditions: Ensure the JSON arrays for actions and conditions are valid JSON strings. Parsing errors will cause failures.
  • Insufficient Permissions: The API key used must have permissions to update automation rules in the specified account.
  • Disabled Automation Not Updating: If the active property is set incorrectly, the rule may not behave as expected. Confirm boolean values are properly set.
  • API Connectivity Issues: Check network connectivity and that the base URL is correctly configured.

Links and References

Discussion