CreateSchedule

Use the workflowAutomationCreateSchedule mutation to create a schedule for a workflow definition.

Tip

The number of schedules and the minimum duration for a given schedule are defined at Workflow System Limits.

Input parameters

The following parameters are available for this API.

Parameter	Data type	Description
`scope`	Object	(Required) The account scope. Contains `id` (your account ID) and `type` (ACCOUNT).
`definition`	Object	(Required) The workflow definition to schedule. Contains `name` (workflow name) and `version` (workflow version).
`cronExpression`	String	(Required) Cron expression defining the schedule frequency (e.g., `"0 0 * * *"` for daily at midnight).
`timezone`	String	(Required) Timezone for the schedule (e.g., `"Asia/Kolkata"`, `"America/New_York"`).
`options`	Object	(Optional) Optional configuration. Contains `logLevel` for controlling execution logging.
`tags`	[EntityTagInput]	(Optional) Tags to apply to the schedule. Each tag requires a `key` (String) and `values` ([String]).

logLevel option

The logLevel option controls the amount of logging information generated during workflow execution.

NONE (default): Generates no log output.
INFO: Outputs step-level information.
DEBUG: Adds an attribute to the step started logs with all the action step inputs, using the format workflowAutomation.inputs.<inputName>: <inputValue>.
TRACE: In addition to DEBUG output, adds an attribute to the step started logs with all the action step outputs, using the format workflowAutomation.outputs.<outputName>: <outputValue>.

Sample request

Use the Query Builder to create and edit a workflow. See NerdGraph API explorer.

mutation {
  workflowAutomationCreateSchedule(
    scope: { id: "12345678", type: ACCOUNT }
    definition: { name: "healthyHeartbeat", version: 1 }
    cronExpression: "0 0 * * *"
    timezone: "Asia/Kolkata"
    options: { logLevel: DEBUG }
    tags: [{ key: "environment", values: ["production"] }]
  ) {
    scheduleId
  }
}

Workflow entity overview

Learn about cron expressions and scheduling workflows

Get schedules

List all schedules in your account

Delete schedule

Remove a schedule when no longer needed

Workflow limits

Understand schedule frequency and count limits

Tip

Input parameters .css-21sua1{background:none;border:none;width:0;padding:0;}