automationRuleCreate Mutation

Creates a new automation rule.

Input argument

automationRuleCreate accepts a single input argument, an input type, which contains the values it uses.

The fields inside input are:

actions ([AutomationRuleActionInput!]!)

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

clientMutationId (String)

A unique identifier for the client performing the mutation.

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.

description (String)

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

disabled (Boolean)

Whether the automation rule should not be triggered.

expressions ([AutomationRuleExpressionInput!]!)

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
name (String!)

The name of the automation rule.

ownerId (ID)

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.

Return fields

automationRule (AutomationRule)

Record after mutation.

clientMutationId (String)

A unique identifier for the client performing the mutation.

errors ([ValidationError!])

Errors encountered during the mutation.