Tasks

Schedule Task

Schedules actions to be run

The Schedule Task can be used to run actions at a future date. A schedule works by setting triggers that fire at specific times, which then run the actions configured on the schedule.

This family of tasks covers the full lifecycle of a schedule: creating one, removing it, fetching its details, and listing all the schedules on a stub.

# Trigger Types

There are three types of triggers that can be set for a schedule:

• Cron Triggers - Expressed using a cron expression
• Once Triggers - Expressed using a SugarTime date and time
• Repeated Triggers - Similar to once triggers, but can fire multiple times

# In this section

• Set Schedule — create a schedule with triggers and the actions to run
• Remove Schedule — remove a schedule by schedule_name or scheduleuuid
• Get Schedule — get the details of a specific schedule
• List Schedules — list all schedules created on a stub

# Basic usage

Use the set_schedule task to schedule one or more actions to run when a trigger fires. See Set Schedule for the full parameter reference.