Actions113
- Contacts Actions
- Contact Actions
- Automation Rule Actions
- Help Center Actions
- Conversations Actions
- Conversation Assignment Actions
- Conversation Labels Actions
- Inboxes Actions
- Messages Actions
- Integrations Actions
- Teams Actions
- Custom Filters Actions
- Webhooks Actions
- Reports Actions
- Accounts Actions
- Account Users Actions
- Agent Bots Actions
- Users Actions
- Contacts API Actions
- Inbox API Actions
- Conversations API Actions
- Messages API Actions
- CSAT Survey Page Actions
- Account Agent Bots Actions
- Agents Actions
- Canned Responses Actions
- Custom Attributes Actions
- Canned Response Actions
Overview
This node allows you to add a new automation rule to a specified account in ChatWoot. Automation rules help automate actions based on specific events and conditions within the account, such as labeling messages or triggering workflows when certain criteria are met.
Common scenarios include:
- Automatically tagging incoming messages containing specific keywords.
- Triggering notifications or other actions when conversations are created or updated.
- Enabling or disabling automation rules dynamically for better workflow management.
For example, you can create a rule that adds a "support" label to any message that contains the word "help" when a new message is created.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric ID of the account where the automation rule will be added. |
| Name | The name of the automation rule (e.g., "Add label on message create event"). |
| Description | A description explaining what the automation rule does and the actions it performs. |
| 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: adding labels like "support". |
| Conditions | JSON array defining the conditions under which the automation rule applies. Example: message content contains "help". |
Output
The node outputs JSON data representing the newly created automation rule as returned by the ChatWoot API. This typically includes details such as the rule's ID, name, description, event name, active status, actions, and conditions.
If the node supports binary data output, it would relate to attachments or files associated with the automation rule, but this node primarily deals with JSON data.
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 to create automation rules.
Troubleshooting
- Invalid Account Id: Ensure the provided account ID exists and is accessible with your API credentials.
- Malformed JSON in Actions or Conditions: The
actionsandconditionsproperties expect valid JSON arrays. Invalid JSON will cause errors. - Permission Errors: Make sure the API key has sufficient permissions to create automation rules.
- Event Name Not Supported: Use only the supported event names ("conversation_created", "conversation_updated", "message_created").
- API Connectivity Issues: Verify network connectivity and correct base URL configuration.
Links and References
- ChatWoot API Documentation
- Automation Rules Guide - ChatWoot (if available)