automation_rule_item

idinteger

The ID of the automation rule

account_idinteger

Account Id

namestring

The name of the rule

Example: Add label on message create event

descriptionstring

Description to give more context about the rule

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

event_namestring

Automation Rule event, on which we call the actions(conversation_created, conversation_updated, message_created)

Possible values: [conversation_created, conversation_updated, message_created]

Example: message_created

conditions object[]

Array of conditions on which conversation/message filter would work

Array [

valuesstring[]

attribute_keystring

query_operatorstring

filter_operatorstring

]

actions object[]

Array of actions which we perform when condition matches

Array [

action_namestring

action_paramsstring[]

]

created_oninteger

The timestamp when the rule was created

activeboolean

Enable/disable automation rule

automation_rule_item

{
  "id": 0,
  "account_id": 0,
  "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",
  "conditions": [
    {
      "attribute_key": "content",
      "filter_operator": "contains",
      "values": [
        "help"
      ],
      "query_operator": "and"
    }
  ],
  "actions": [
    {
      "action_name": "add_label",
      "action_params": [
        "support",
        "sales"
      ]
    }
  ],
  "created_on": 0,
  "active": true
}