Create scheduled run

createScheduledRun(projectReference: String!, scheduleId: ID!, runName: String, idempotencyKey: String): ScheduledRunCreateResult!

Requires project.runs.write.

Arguments

ArgumentTypeRequiredDescription
projectReferenceString!YesRequires project.runs.write.
scheduleIdID!Yes
runNameStringNo
idempotencyKeyStringNoSupply the same key to retry safely; unkeyed manual invocations remain supported.

Response

Returns ScheduledRunCreateResult!. Open the type for its fields and nested types.

FieldTypeDescription
runIdID!The run started now. Its kind (task, workflow or agent) follows the schedule target. Admission does not grant read access to a private run.
runExecutionIdID!
scheduleIdID!

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
mutation CreateScheduledRun($projectReference: String!, $scheduleId: ID!, $runName: String, $idempotencyKey: String) {
  createScheduledRun(projectReference: $projectReference, scheduleId: $scheduleId, runName: $runName, idempotencyKey: $idempotencyKey) {
    runId
    runExecutionId
    scheduleId
  }
}
json
{
  "projectReference": "example",
  "scheduleId": "00000000-0000-4000-8000-000000000001"
}