automation_rule_create_update_payload

namestring

Rule name

Example: Add label on message create event

descriptionstring

The description about the automation and actions

Example: Add label support and sales on message create event if incoming message content contains text help

event_namestring

The event when you want to execute the automation actions

Possible values: [conversation_created, conversation_updated, conversation_resolved, message_created]

Example: message_created

activeboolean

Enable/disable automation rule

actionsobject[]

Array of actions which you want to perform when condition matches, e.g add label support if message contains content help.

conditionsobject[]

Array of conditions on which conversation filter would work, e.g message content contains text help.

automation_rule_create_update_payload

{
  "name": "Add label on message create event",
  "description": "Add label support and sales on message create event if incoming message content contains text help",
  "event_name": "message_created",
  "active": true,
  "actions": [
    {
      "action_name": "add_label",
      "action_params": [
        "support"
      ]
    }
  ],
  "conditions": [
    {
      "attribute_key": "content",
      "filter_operator": "contains",
      "query_operator": "OR",
      "values": [
        "help"
      ]
    }
  ]
}