Component schema

ScheduledAgenticWorkflowTriggerSpec

object1 direct reference

Definition

stringrequired

Crontab-notation to express when the automation is supposed to run.

1
{minute} {hour} {day} {month} {weekday}

For example, 0 12 * * MON-WED,FRI is every M/Tu/W/F at noon.

Predefined schedules are also supported:

@yearly (or @annually): Run once a year at midnight on January 1st.
@monthly: Run once a month at midnight on the first day.
@weekly: Run once a week at midnight on Sunday.
@daily (or @midnight): Run once a day at midnight.
@hourly: Run once an hour at the beginning of the hour.
@every <duration>: Run at fixed intervals, e.g. @every 1h30m or @every 5m.

ScheduleTriggerVariableName[]read only

The trigger-specific variables available as {{variable.name}} when this trigger fires. This is in addition to the built-in variables that are always available.

Used by 1

These schemas and endpoints reference this type directly.

SchemaScheduledAgenticWorkflowTrigger

json

OpenAPI source12345678910111213141516171819
{
  "properties": {
    "cron": {
      "description": "Crontab-notation to express when the automation is supposed to run.\n\n```\n{minute} {hour} {day} {month} {weekday}\n```\n\nFor example, `0 12 * * MON-WED,FRI` is every M/Tu/W/F at noon.\n\nPredefined schedules are also supported:\n\n- `@yearly` (or `@annually`): Run once a year at midnight on January 1st.\n- `@monthly`: Run once a month at midnight on the first day.\n- `@weekly`: Run once a week at midnight on Sunday.\n- `@daily` (or `@midnight`): Run once a day at midnight.\n- `@hourly`: Run once an hour at the beginning of the hour.\n- `@every <duration>`: Run at fixed intervals, e.g. `@every 1h30m` or `@every 5m`.\n",
      "type": "string"
    },
    "availableVariables": {
      "description": "The trigger-specific variables available as `{{variable.name}}` when this trigger fires.\nThis is in addition to the built-in variables that are always available.\n",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ScheduleTriggerVariableName"
      },
      "readOnly": true
    }
  },
  "required": [
    "cron"
  ]
}