CreateScheduleBody

Request body for creating a Schedule.

Definition

TypeScript

interface CreateScheduleBody {
  workspaceId: string;
  name: string;
  cronExpr: string;
  timezone?: string | undefined;
  missedRunPolicy?: "skip" | "fire" | undefined;
  payload?: Record<string, unknown> | null | undefined;
  enabled?: boolean | undefined;
}

Fields

Field	Type	Notes
`workspaceId`	`string`	`required` — Workspace that will own the new schedule.
`name`	`string`	`required` — Human-readable label.
`cronExpr`	`string`	`required` — Standard 5-field cron expression.
`timezone`	`string \| undefined`	`optional` — IANA timezone name (default 'UTC').
`missedRunPolicy`	`"skip" \| "fire" \| undefined`	`optional`
`payload`	`Record<string, unknown> \| null \| undefined`	`optional` — Optional JSON payload carried into every fire event.
`enabled`	`boolean \| undefined`	`optional` — Default true.