schedule + scheduleIdTemporal Schedules
Server-managed durable starts for Activity or Workflow endpoints.
When to use
Use this page while designing, implementing, operating, or troubleshooting scheduled and durable execution.
Behavior
- A non-empty
schedulemakes the runtime create a Temporal Schedule with the configuredscheduleId. - If that ID already exists, the runtime describes it and validates ServiceLib ownership, Workflow type, and Task Queue instead of creating a duplicate.
- The current create-or-validate path does not update the cron expression or policies of an existing Temporal Schedule.
- Each occurrence starts the endpoint execution type.
- The schedule callback receives
backend: temporal.
What to enter
Cron Schedule and Temporal Schedule ID are different values. The first controls when an occurrence is created; the second identifies the durable server object.
- Cron Schedule example:
*/10 * * * *. - Temporal Schedule ID example:
example-automation-workflow-schedule. - Keep the ID stable across restarts and deployments so the service finds the same server-side object.
When empty values are correct
A Temporal endpoint called through a Sink usually has no schedule of its own. In that case both fields remain empty.
schedule: ""scheduleId: ""
Scheduled endpoint example
When the endpoint owns a durable schedule, fill both fields and keep timezone set to UTC.
schedule: "*/10 * * * *"scheduleId: "example-automation-workflow-schedule"timezone: "UTC"
Schedule identity properties
Keep the durable ID stable across deployments.
schedulestringFive-field expression without seconds: minute hour day-of-month month day-of-week. Empty means on-demand only.
scheduleIdstringPermanent user-chosen Schedule identity in the configured Temporal namespace.
Required when schedule is non-empty.temporalExecutionTypeenumExecution started by each occurrence.
Allowed:Activity, WorkflowTemporal Schedule configuration
schedule: "*/10 * * * *"
scheduleId: "example-automation-workflow-schedule"
timezone: UTC
overlapPolicy: Skip
missedRunPolicy: FireOnce
temporalExecutionType: Workflow