Actions113
- Accounts Actions
- Account Users Actions
- Agent Bots Actions
- Users Actions
- Inbox API Actions
- Contacts API Actions
- Conversations API Actions
- Messages API Actions
- CSAT Survey Page Actions
- Account Agent Bots Actions
- Agents Actions
- Canned Responses Actions
- Canned Response Actions
- Custom Attributes Actions
- Contacts Actions
- Contact Actions
- Automation Rule Actions
- Help Center Actions
- Conversations Actions
- Conversation Assignment Actions
- Conversation Labels Actions
- Inboxes Actions
- Messages Actions
- Integrations Actions
- Webhooks Actions
- Teams Actions
- Custom Filters Actions
- Reports Actions
Overview
This node operation 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.
Typical use cases include:
- Automatically tagging incoming messages containing specific keywords.
- Enabling or disabling automation rules dynamically.
- Modifying the description or name of an automation rule to reflect updated business logic.
- Changing the event trigger for the automation rule (e.g., from message creation to conversation update).
For example, you might update a rule to add a "support" label whenever a new message contains the word "help," ensuring that support agents can quickly identify relevant conversations.
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 or updated 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 (true) or disable (false) the automation rule. |
| Actions | JSON array defining the actions to perform when the rule conditions match. Example action: adding labels like "support". |
| Conditions | JSON array specifying the conditions under which the automation rule triggers. For example, message content containing specific text. |
Output
The node outputs JSON data representing the updated automation rule object returned by the ChatWoot API after the update operation. This typically includes fields such as the rule's ID, name, description, active status, event name, conditions, and actions reflecting the current state of the automation rule.
If the node supports binary data output, it is not indicated here; thus, the output is purely JSON-based.
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 depends on the ChatWoot REST API endpoint for updating automation rules within an account.
Troubleshooting
- Invalid Account Id or Rule Id: If the provided account or automation rule ID does not exist or is incorrect, the API will return an error. Verify IDs before running the node.
- Malformed JSON in Actions or Conditions: Since these properties expect JSON arrays, invalid JSON syntax will cause parsing errors. Ensure valid JSON formatting.
- Insufficient Permissions: The API key used must have permissions to update automation rules. Otherwise, authorization errors will occur.
- Disabled Automation Rule Not Updating: If the
activeproperty is set incorrectly or omitted, the rule may remain enabled or disabled unintentionally. - API Connectivity Issues: Network problems or incorrect base URL configuration can prevent successful API calls.