schedule.create

Register a recurring schedule that starts a target workflow every N minutes

Register a recurring schedule that the backend scheduler fires.

Overview

Property	Value
Workflow type	Atomic
Library	App-composition
Version	1.0

Input Schema

Field	Type	Required	Default	Description
organization_uuid	uuid	Yes	—	—
target_workflow_type	string	Yes	—	Registered workflow type to start each occurrence, e.g. data.foo.list or virtual.<uuid>@2
interval_minutes	integer	Yes	—	Minutes between runs (minimum 1)
name	string	No	—	Human-facing label (defaults to the target type)
initial_data	json	No	—	Inputs the run starts with (organization_uuid is injected automatically)
active	boolean	No	True	Start firing immediately (false = paused)
user_uuid	uuid	No	—	Creator (auto-filled from the conversation)

Output Schema

Field	Type	Required	Default	Description
schedule_uuid	uuid	Yes	—	—
target_workflow_type	string	Yes	—	—
interval_minutes	integer	Yes	—	—
next_run_at	string	Yes	—	—
active	boolean	Yes	—	—
name	string	Yes	—	—
failure_reason	string	No	—	Engine-stamped human-readable failure reason
failure_type	string	No	—	Engine-stamped failure category
failed_action	string	No	—	Engine-stamped action method that raised
failed_at_state	string	No	—	Engine-stamped state when the workflow failed
failed_step	string	No	—	Engine-stamped DAG step that failed
failed_layer	string	No	—	Engine-stamped DAG layer that failed
error	string	No	—	Engine-stamped exception message
error_type	string	No	—	Engine-stamped exception class name

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	complete	Register schedule
completed	No	Yes	Yes	—	Scheduled
failed	No	Yes	No	—	Schedule failed

State Diagram

Transitions

From	Action	To	Description
pending	complete	completed	—
pending	fail	failed	—

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "schedule.create",
  "initial_data": {
    "organization_uuid": "value",
    "target_workflow_type": "value",
    "interval_minutes": 123
  }
}