Skip to main content
Anchor to AutomationRecurrenceConfigField

AutomationRecurrenceConfigField

object

Requires write_automations access scope.

A recurring schedule, encoded as a string containing a JSON array of iCalendar schedules. Each schedule is a DTSTART line with a TZID from timeZones, a newline, and an RRULE line, for example DTSTART;TZID=America/Toronto:20261101T090000\nRRULE:FREQ=WEEKLY;BYDAY=MO.

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 timeZonestimeZones
•[AutomationTimeZone!]!
non-null

The available time zones.

Show fields
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?