SCHEDULE
Sets a specified time in the future for the subsequent actions to execute. Can be a specific time or date, or it may be a defined elapsed time from the current time.
Properties
Schedule Type
schedule_type
When to run the scheduled process.
| valid options | |
|---|---|
| Delay from current time FROM_NOW | The action will run after a specified delay from the current time. |
| At a specific time SPECIFIC_TIME | The action will run at the absolute time and date specified. |
Scheduled Time
schedule_at
The specific time and date to run the subsequent actions.
Delay Quantity
schedule_delayQty
The amount of time to wait to run the subsequent actions. Factored by the delay units.
Delay Units
schedule_delayUnits
The time units by which the delay quantity is factored.
| valid options | |
|---|---|
| Seconds s | Delay by seconds. |
| Minutes m | Delay by minutes. |
| Hours h | Delay by hours. |
| Days d | Delay by days. |
Scheduled Process Is Cancellable
schedule_cancellable
When enabled, any scheduled previously scheduled action that has been previously scheduled may be cancelled by a Cancel Scheduled Action process that has a matching cancellation key.
Cancellation Key Template ${}
schedule_cancellationKey
The key used to identify previously scheduled processes so that they may be cancelled. Accepts template syntax.
Identifier Template ${}
schedule_identifier
Template used to help identify the scheduled process in the event logs. Please set this to make your logs easier to interpret.