Using API to schedule task or plan runs

Use schedule dedicated API endpoints to easily arrange how and when a task or plan can be executed with multiple triggers.

Schedules created and managed with these endpoints support all types of tasks or plans.
Multiple time triggers can be added to a schedule. When a schedule is associated to a task or plan, all these triggers are active to that task or plan.

This way, when a task or plan needs multiple triggers, defining them becomes straightforward and flexible. You do not need to duplicate your tasks or plans for each of the triggers anymore.
You can easily simulate all the events to be triggered by your schedule before applying it to a task or plan. This mechanism allows you to prepare and fine-tune a schedule without taking any risk to impact the actual executions.
A schedule can be duplicated so that you can safely manage schedule changes, keep schedule history and reuse schedule for several tasks or plans.
These endpoints are designed to avoid redundant trigger definitions and tight event frequency.
For these purposes, an interval between two events must be greater than or equal to 5 minutes. This frequency is verified for the events to be triggered in the future, taking into account the bissextile years.
Only an orphan schedule can be deleted. Once associated with a task or plan, it is protected from accidental deletion.
A schedule supports time triggers only. For this reason, a webhook trigger, which is merely event related, must be used as a separate option, that is to say, without being mixed with the time triggers.

The following sections describe how to schedule task runs for demonstration purposes. The same workflow applies to plans, too.

The whole lifecycle of a schedule is also demonstrated at the same time.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!