Scheduled

Fires Output
On a predefined schedule and when the workflow is run manually Optional Schedule Data (JSON)

The Scheduled trigger runs the workflow on a regularly occurring schedule, as defined by a cron expression. It also fires on a predefined schedule and when the workflow is run manually. The output can be optional schedule data in JSON format.

Some examples of schedules that can be used include:

  • Every 15 Minutes
  • Hourly
  • Daily
  • 3 times per day, at 9AM, 12PM, and 4PM
  • Weekly
  • Monthly
  • Daily, only on weekdays
  • Monthly, on the last day of the month (31st / 30th / 28th)
  • Monthly, on the first weekday of the month (if the 1st is Sat / Sun, run on Mon)
  • Annually, on the first day in July

Using the Schedule Builder

A convenient Schedule Builder is available in the Scheduled Settings pane to build a cron expression.

Do the following to use the Schedule Builder:

  1. Select a tab:
    • Hourly tab - Schedule an hourly workflow.
    • Daily tab - Schedule a daily workflow.
    • Weekly tab - Schedule a weekly workflow.
    • Monthly tab - Schedule a monthly workflow.
  2. Use the drop-downs to customize the schedule.
  3. Example: To run a workflow on the first weekday of each month at 8:30 AM UTC, select First weekday, 8, and 30 from the drop-downs.

  4. Click Apply to save the schedule.

Tip: Be sure to also save the workflow after saving the schedule. Clicking Apply in the schedule builder does not save the workflow definition.

Note: A scheduled workflow can also be run manually. See Manual Trigger for more information.

Schedule data

Optionally include the schedule’s trigger data in the workflow payload. The trigger data follows this format:

Copy
{
    "trigger": {
        "scheduledStartTimeUtc": "2024-06-19T19:32:00+00:00",
        "actualStartTimeUtc": "2024-06-19T19:32:00.0000834+00:00",
        "cronExpression": "0 32 19 * * ? *"    }
}

The trigger property contains three sub-properties:

  • scheduledStartTimeUtc - The time at which the workflow was scheduled to run, according to the scheduling engine.
  • actualStartTimeUtc - The time that the workflow actually began processing.
  • cronExpression - A copy of the cron expression from the trigger’s configuration.

Properties

Name

Type

Templatable

Notes

Cron Expression

Text

No

Specify a valid 7-segment Quartz-like cron expression that should be used for the schedule.

Include Schedule Data

Checkbox

No

If checked, the schedule trigger data is included inside the trigger property of the workflow payload.