Skip to main content

AutomationComponentField

A configurable field on an automation condition or action.

type AutomationComponentField {
  description: String
  fieldType: AutomationComponentFieldTypeEnum
  label: String!
  name: String!
  options: [AutomationComponentFieldOption!]!
  referenceType: AutomationReferenceTypeEnum
  required: Boolean!
}

Fields​

AutomationComponentField.description ● String scalar common​

Help text for this field.

AutomationComponentField.fieldType ● AutomationComponentFieldTypeEnum enum automations​

The editor and value type for this field.

AutomationComponentField.label ● String! non-null scalar common​

The human-facing label for this field.

AutomationComponentField.name ● String! non-null scalar common​

The configuration key stored for this field.

AutomationComponentField.options ● [AutomationComponentFieldOption!]! non-null object automations​

Selectable options for this field.

AutomationComponentField.referenceType ● AutomationReferenceTypeEnum enum automations​

The referenced record type when this field stores record IDs.

AutomationComponentField.required ● Boolean! non-null scalar common​

Whether this field is required by the component schema.

Member Of​

AutomationAction object ● AutomationCondition object