Create schedule - Veryfront

createSchedule(projectReference: String!, input: CreateScheduleInput!): Schedule!

Requires project.runs.write.

Arguments

Argument	Type	Required
`projectReference`	`String!`	Yes
`input`	`CreateScheduleInput!`	Yes

Input fields

input

CreateScheduleInput

Field	Type	Required	Description
`name`	`String!`	Yes
`target`	`ScheduleTargetInput!`	Yes
`schedule`	`String!`	Yes	The cron expression.
`timezone`	`String`	No	IANA time zone name.
`runtimeTargetKind`	`RuntimeTargetKind`	No
`runtimeTargetEnvironmentId`	`ID`	No
`runtimeTargetBranchId`	`ID`	No
`config`	`JSON`	No	JSON object passed to each run.
`timeoutSeconds`	`Int`	No
`backoffLimit`	`Int`	No
`concurrencyPolicy`	`ScheduleConcurrencyPolicy`	No
`maxRuns`	`Int`	No	Null for no limit.
`definitionSource`	`ScheduleDefinitionSource`	No	manual (default), or source to activate a source schedule, which requires sourceTriggerId, sourcePath and sourceHash.
`sourceTriggerId`	`String`	No
`sourcePath`	`String`	No
`sourceHash`	`String`	No

Response

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

Field	Type	Description
`id`	`ID!`
`projectId`	`ID!`
`name`	`String!`
`status`	`ScheduleStatus!`
`target`	`ScheduleTarget!`
`schedule`	`String!`	The cron expression.
`timezone`	`String!`
`runtimeTargetKind`	`RuntimeTargetKind!`

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

Example

mutation CreateSchedule($projectReference: String!, $input: CreateScheduleInput!) {
  createSchedule(projectReference: $projectReference, input: $input) {
    id
    projectId
    name
    status
    createdAt
  }
}

{
  "projectReference": "example-project",
  "input": {
    "name": "Nightly report",
    "target": {
      "kind": "task",
      "id": "nightly-report"
    },
    "schedule": "0 2 * * *"
  }
}