AutomationRule Object

Root Connection

All AutomationRule objects of an account are accessible by a query on the root connection automationRules. Such a query will return a AutomationRuleConnection!, which contains the AutomationRule objects in its nodes field.

automationRules (AutomationRuleConnection!)

Root connection for retrieving AutomationRule records.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

filter AutomationRuleFilter

Filter to determine which AutomationRule records are returned.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

order [AutomationRuleOrder!]

Order of the AutomationRule records returned.

view AutomationRuleView

View name.

The default value is current_account.

Fields

The fields in this section list which values can be retrieved when querying AutomationRule records.

account (Account)

The account this record belongs to.

actions ([AutomationRuleAction!])

The Actions field is used to define actions that should be executed when the condition of the automation rule is met.

condition (String)

The Condition field is used to define the condition that needs to be met in order for the update action(s) of the rule to be performed. For example: is_assigned and !badge.

createdAt (ISO8601Timestamp)

The date and time at which the record was created.

description (String)

'A high-level description of the automation rule's function.'

disabled (Boolean)

Whether the automation rule should not be triggered.

expressions ([AutomationRuleExpression!])

The Expressions field is used to define expressions that can subsequently be used to define the rule's conditions and the update action(s) that the rule is to perform.

generic (String)

When the automation rule is not linked to one specific record but to all records of a type, the Generic field contains the record type. Valid values are:

  • request
  • task
  • risk
  • ci
  • scim_user
  • scim_group
id (ID!)

Unique identifier of the object.

name (String)

The name of the automation rule.

owner (HasAutomationRules)

The record that the automation rule is linked to.

position (Int)

The Position field dictates the order in which the automation rule is executed.

source (String)

An identifier for the client application submitting the resource or the name of an external system

sourceID (String)

The unique identifier of the resource in an external system

trigger (String)

The Trigger field is used to specify when the automation rule is to be triggered, for example on status update or on note added.

updatedAt (ISO8601Timestamp)

The date and time of the last update of the record. If the record has no updates it contains the createdAt value.

Implements

AutomationRule implements the following interfaces. This means that fragments defined on these interfaces may be used in queries returning a AutomationRule.