Skip to content

Commit fd3727d

Browse files
authored
Platform API: available workflow schedule timeframe phrases (#451)
1 parent e8b50fe commit fd3727d

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

platform/api/workflows.mdx

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ specify the settings for the workflow, as follows:
3232
"source_id": "<source-connector-id>",
3333
"destination_id": "<destination-connector-id>",
3434
"workflow_type": "<type>",
35-
"schedule": "<cron-expression>"
35+
"schedule": "<schedule-timeframe>"
3636
}'
3737
```
3838
</Accordion>
@@ -57,7 +57,7 @@ specify the settings for the workflow, as follows:
5757
"source_id": "<source-connector-id>",
5858
"destination_id": "<destination-connector-id>",
5959
"workflow_type": "<type>",
60-
"schedule": "<cron-expression>"
60+
"schedule": "<schedule-timeframe>"
6161
}
6262
```
6363

@@ -73,12 +73,21 @@ Replace the preceding placeholders as follows:
7373
- `<destination-connector-id>` (_required_) - The ID of the target destination connector. To get the ID,
7474
use the `GET` method to call the `/destinations` endpoint. [Learn more](/platform/api/overview#list-destination-connectors).
7575
- `<type>` (_required_) - The workflow optimization type. Available values include `advanced`, `basic`, and `platinum`.
76-
- `<cron-expression>` - The repeating automatic run schedule, specified as a cron expression, for example
77-
`59 11 * * 4` to run the workflow at 11:59 PM every Thursday.
78-
[Get help building cron expressions](https://crontab.guru/).
79-
[Learn more](https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html).
80-
81-
If `schedule` is not specified or if `crontab_entries` is empty, the workflow does not automatically run on a repeating schedule.
76+
- `<schedule-timeframe>` - The repeating automatic run schedule, specified as a predefined phrase. The available predefined phrases are:
77+
78+
- `every 15 minutes`: Every 15 minutes (cron expression: `*/15 * * * *`).
79+
- `every hour`: At the first minute of every hour (cron expression: `0 * * * *`).
80+
- `every 2 hours`: At the first minute of every second hour (cron expression: `0 */2 * * *`).
81+
- `every 4 hours`: At the first minute of every fourth hour (cron expression: `0 */4 * * *`).
82+
- `every 6 hours`: At the first minute of every sixth hour (cron expression: `0 */6 * * *`).
83+
- `every 8 hours`: At the first minute of every eighth hour (cron expression: `0 */8 * * *`).
84+
- `every 10 hours`: At the first minute of every tenth hour (cron expression: `0 */10 * * *`).
85+
- `every 12 hours`: At the first minute of every twelfth hour (cron expression: `0 */12 * * *`).
86+
- `daily`: At the first minute of every day (cron expression: `0 0 * * *`).
87+
- `weekly`: At the first minute of every Sunday (cron expression: `0 0 * * 0`).
88+
- `monthly`: At the first minute of the first day of every month (cron expression: `0 0 1 * *`).
89+
90+
If `schedule` is not specified, the workflow does not automatically run on a repeating schedule.
8291

8392
## Update a workflow
8493

0 commit comments

Comments
 (0)