Scheduled

Runs the workflow on a regularly occurring schedule, as defined by a cron expression.

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

Note: Fires: On a predefined schedule and when the workflow is run manually

Note: Output: Optional Schedule Data (JSON)

Using the Schedule Builder

A convenient Schedule Builder is available in the Scheduled trigger properties window, which you can use to build a cron expression using a GUI.

Do the following to use the Schedule Builder:

  1. Click the tab that matches the frequency you’d like, and then use the drop-downs to customize the schedule. For example, to run a workflow on the first weekday of each month at 8:30 AM UTC:
  2. When you are satisfied with the schedule preview in the Schedule Summary box, click Apply to save the schedule.

Tip! Remember to also save the workflow when you’re finished. Clicking Apply in the schedule builder does not save the workflow definition.

Note: A scheduled workflow can also be run manually. See Manual Trigger documentation.

Schedule data

You can optionally include the schedule’s trigger data in your workflow payload. The trigger data looks like this:

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.