Scheduler
1. Overview
The Scheduler component (schedule) automatically fires the flow at scheduled times, using a cron expression. It's the starting point of flows that need to run periodically (for example, every day at 6 AM, or every 15 minutes).
Use it when the flow needs to run on a schedule, without depending on an external action (like an HTTP call or an event). Works only as an entry trigger — it can't be used in the middle or end of a flow.
2. Prerequisites
No external credentials — scheduling runs internally in the flow engine.
3. Authentication and Connection
Not applicable.
4. Configuration / Supported Operations
The component has a single configuration: the expression that defines when the flow should fire.
| Field | Required | Type | Description | Example |
|---|---|---|---|---|
cron | Yes | Text (cron expression) | Defines the flow's firing frequency/time. | "0 0 6 * * ?" (every day at 6 AM) |
On each fire, the flow receives an empty body ({}) and a startTimestamp header with the exact firing time.
5. Practical Examples
Simple example: fire a flow every day at 6 AM, to generate a daily report.
Component configuration (start of the flow):
{
"componentName": "schedule",
"configurations": {
"cron": "0 0 6 * * ?"
}
}
Body received by the flow on each fire:
{}
Available header:
{
"startTimestamp": "1753000800000"
}
Advanced example: fire a flow every 15 minutes, during business hours, to check for pending items.
Component configuration:
{
"componentName": "schedule",
"configurations": {
"cron": "0 0/15 8-18 * * ?"
}
}
Body received on each fire:
{}
6. Common Errors and Troubleshooting
| Error / Symptom | Likely Cause | How to Fix |
|---|---|---|
| "Error to create route" | The cron expression is malformed. | Review the cron expression's syntax (Quartz format: seconds, minutes, hours, day of month, month, day of week). |
| Flow doesn't fire at the expected time | The cron expression doesn't match the desired time, or is using a different time zone than expected. | Test the cron expression in a validation tool and confirm the server's time zone. |