Skip to main content
Anchor to AutomationConditionConfigField

AutomationConditionConfigField

object

Requires write_automations access scope.

A condition expression that decides which branch an automation takes, written in Flow's condition syntax. Compare a field path with a literal or another path using ==, !=, >, >=, <, <=, string operators such as start_with? and include?, or unary checks such as nil? and empty_or_nil?. Test lists with any?, all?, or none? and an item variable, and combine expressions with && or ||. Example: (order.totalPrice > 100) && (order.tags any? |tags_item| (tags_item == 'vip')).

Anchor to FieldsFields

Anchor to defaultValuedefaultValue
•String

The default value encoded as a string in the format expected by this field type.

Anchor to descriptiondescription
•String

The field description.

Anchor to idid
•String!
non-null

The field ID written into the automation step's configuration as config_field_id.

Anchor to labellabel
•String!
non-null

The field display name.

Anchor to requiredrequired
•Boolean!
non-null

Whether the field must have a value.

Anchor to validationsvalidations
•[AutomationTaskConfigFieldValidation!]!
non-null

The validations that can be checked before saving the workflow.

Show fields
Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to AutomationTaskConfigFieldAutomationTaskConfigField
•interface
Was this section helpful?