Skip to main content
Skip table of contents

Scheduled

Fires

On a predefined schedule

When the workflow is run manually

Ouptut

✳️ Optional Schedule Data (JSON)

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

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.

image-20240619-192130.png

Select the tab that matches the frequency you’d like, and then use the dropdowns to customize the schedule. For example, to run a workflow on the first weekday of each month at 8:30 AM UTC:

image-20240619-192300.png

When you are satisfied with the schedule preview in the Schedule Summary box, press Apply to save the schedule.

Tip: Remember to also save the workflow when you’re finished - pressing Apply in the schedule builder doesn’t save the workflow definition.

Schedule Data

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

JSON
{
    "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

(error)

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

Include Schedule Data

Checkbox

(error)

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

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.