Get Schedule
Get a schedule by id.
Type
schedule.getFolder
scheduleChannels
Any
Pipe
Value
Scope
Any
Get Schedule loads a one-shot schedule by id. Use it after Create Schedule (pipe.value.id) or with an id from the Schedule list.
Configure
| Setting | Description |
|---|---|
| Schedule ID | Schedule id (required; literal or variable) |
Handles
| Handle | Role |
|---|---|
| In (target) | Incoming connection |
| Out (source) | Continues after the schedule is loaded |
Pipe schema
The next block reads this on the data pipe (pipe.value):
| Key | Type | Description |
|---|---|---|
id | text | Schedule id |
name | text | Name |
description | text | Description when set |
isActive | boolean | Whether the job is active |
mode | text | specificTime or timeoutMinutes |
scheduledAt | datetime | Fire time in specific-time mode |
timeoutMinutes | number | Delay in timeout mode |
targetType | text | agent or workflow |
targetRef | text | Target id |
agendaJobId | text | Job-runner id when set |
lastRunAt | datetime | Last run time when set |
status | text | pending, running, success, or failed |
inputData | object | Input passed to the target when set |
Use case
- Check
statusbefore sending a notification that a deferred run finished. - Branch with a Condition on
modeorstatus.