Skip to content

Automate browser based workflows with AI

feat: DB migration for workflow schedules (#SKY-8181) (#5140)

Aaron Pereze321c89fa2ce
diff --git a/alembic/versions/2026_03_18_0220-e8c78980ed9d_add_workflow_schedules_table_and_.py b/alembic/versions/2026_03_18_0220-e8c78980ed9d_add_workflow_schedules_table_and_.py
new file mode 100644
index 000000000..2614c0893
--- /dev/null
+++ b/alembic/versions/2026_03_18_0220-e8c78980ed9d_add_workflow_schedules_table_and_.py
@@ -0,0 +1,81 @@
+"""add workflow_schedules table and trigger_type to workflow_runs
+
+Revision ID: e8c78980ed9d
+Revises: def7c03f425d
+Create Date: 2026-03-18 02:20:36.978880+00:00
+
+"""
+
+from typing import Sequence, Union
+
+import sqlalchemy as sa
+
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "e8c78980ed9d"
+down_revision: Union[str, None] = "def7c03f425d"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+ op.create_table(
+ "workflow_schedules",
+ sa.Column("workflow_schedule_id", sa.String(), nullable=False),
+ sa.Column("organization_id", sa.String(), nullable=False),
+ sa.Column("workflow_permanent_id", sa.String(), nullable=False),
+ sa.Column("cron_expression", sa.String(), nullable=False),
+ sa.Column("timezone", sa.String(), nullable=False),
+ sa.Column("enabled", sa.Boolean(), nullable=False, server_default=sa.true()),
+ sa.Column("parameters", sa.JSON(), nullable=True),
+ sa.Column("temporal_schedule_id", sa.String(), nullable=True),
+ sa.Column("name", sa.String(), nullable=True),
+ sa.Column("description", sa.String(), nullable=True),
+ sa.Column("created_at", sa.DateTime(), nullable=False, server_default=sa.text("now()")),
+ sa.Column("modified_at", sa.DateTime(), nullable=False, server_default=sa.text("now()")),
+ sa.Column("deleted_at", sa.DateTime(), nullable=True),
+ sa.PrimaryKeyConstraint("workflow_schedule_id"),
+ )
+ op.create_index(
+ "idx_workflow_schedules_org_workflow",
+ "workflow_schedules",
+ ["organization_id", "workflow_permanent_id"],
+ postgresql_where=sa.text("deleted_at IS NULL"),
+ )
+ op.create_index(
+ "idx_workflow_schedules_org_enabled",
+ "workflow_schedules",
+ ["organization_id", "enabled"],
+ )
+ op.create_index(
+ op.f("ix_workflow_schedules_workflow_permanent_id"),
+ "workflow_schedules",
+ ["workflow_permanent_id"],
+ )
+
+ # Add trigger_type and workflow_schedule_id columns to workflow_runs
+ op.add_column(
+ "workflow_runs",
+ sa.Column("trigger_type", sa.String(), nullable=True),
+ )
+ op.add_column(
+ "workflow_runs",
+ sa.Column("workflow_schedule_id", sa.String(), nullable=True),
+ )
+ op.create_index(
+ op.f("ix_workflow_runs_workflow_schedule_id"),
+ "workflow_runs",
+ ["workflow_schedule_id"],
+ )
+
+
+def downgrade() -> None:
+ op.drop_index(op.f("ix_workflow_runs_workflow_schedule_id"), table_name="workflow_runs")
+ op.drop_column("workflow_runs", "workflow_schedule_id")
+ op.drop_column("workflow_runs", "trigger_type")
+
+ op.drop_index("idx_workflow_schedules_org_workflow", table_name="workflow_schedules")
+ op.drop_index(op.f("ix_workflow_schedules_workflow_permanent_id"), table_name="workflow_schedules")
+ op.drop_index("idx_workflow_schedules_org_enabled", table_name="workflow_schedules")
+ op.drop_table("workflow_schedules")
diff --git a/skyvern/forge/sdk/db/enums.py b/skyvern/forge/sdk/db/enums.py
index de2271258..3f758d43c 100644
--- a/skyvern/forge/sdk/db/enums.py
+++ b/skyvern/forge/sdk/db/enums.py
@@ -12,3 +12,9 @@ class TaskType(StrEnum):
general = "general"
validation = "validation"
action = "action"
+
+
+class WorkflowRunTriggerType(StrEnum):
+ manual = "manual"
+ api = "api"
+ scheduled = "scheduled"
diff --git a/skyvern/forge/sdk/db/id.py b/skyvern/forge/sdk/db/id.py
index 29c7efcd4..5b37d2826 100644
--- a/skyvern/forge/sdk/db/id.py
+++ b/skyvern/forge/sdk/db/id.py
@@ -72,6 +72,7 @@ ORGANIZATION_BILLING_PREFIX = "ob"
WORKFLOW_COPILOT_CHAT_PREFIX = "wcc"
WORKFLOW_COPILOT_CHAT_MESSAGE_PREFIX = "wccm"
SCRIPT_FALLBACK_EPISODE_PREFIX = "sfe"
+WORKFLOW_SCHEDULE_PREFIX = "wfs"
def generate_workflow_id() -> str:
@@ -284,6 +285,11 @@ def generate_script_fallback_episode_id() -> str:
return f"{SCRIPT_FALLBACK_EPISODE_PREFIX}_{int_id}"
+def generate_workflow_schedule_id() -> str:
+ int_id = generate_id()
+ return f"{WORKFLOW_SCHEDULE_PREFIX}_{int_id}"
+
+
############# Helper functions below ##############
def generate_id() -> int:
"""
diff --git a/skyvern/forge/sdk/db/models.py b/skyvern/forge/sdk/db/models.py
index b7f129193..9ccee8785 100644
--- a/skyvern/forge/sdk/db/models.py
+++ b/skyvern/forge/sdk/db/models.py
@@ -60,6 +60,7 @@ from skyvern.forge.sdk.db.id import (
generate_workflow_permanent_id,
generate_workflow_run_block_id,
generate_workflow_run_id,
+ generate_workflow_schedule_id,
generate_workflow_script_id,
generate_workflow_template_id,
)
@@ -326,6 +327,39 @@ class WorkflowModel(Base):
is_saved_task = Column(Boolean, default=False, nullable=False)
+class WorkflowScheduleModel(Base):
+ __tablename__ = "workflow_schedules"
+ __table_args__ = (
+ Index(
+ "idx_workflow_schedules_org_workflow",
+ "organization_id",
+ "workflow_permanent_id",
+ postgresql_where=text("deleted_at IS NULL"),
+ ),
+ Index("idx_workflow_schedules_org_enabled", "organization_id", "enabled"),
+ )
+
+ workflow_schedule_id = Column(String, primary_key=True, default=generate_workflow_schedule_id)
+ organization_id = Column(String, nullable=False)
+ workflow_permanent_id = Column(String, nullable=False, index=True)
+ cron_expression = Column(String, nullable=False)
+ timezone = Column(String, nullable=False)
+ enabled = Column(Boolean, nullable=False, default=True, server_default=sqlalchemy.true())
+ parameters = Column(JSON, nullable=True)
+ temporal_schedule_id = Column(String, nullable=True)
+ name = Column(String, nullable=True)
+ description = Column(String, nullable=True)
+
+ created_at = Column(DateTime, default=datetime.datetime.utcnow, nullable=False)
+ modified_at = Column(
+ DateTime,
+ default=datetime.datetime.utcnow,
+ onupdate=datetime.datetime.utcnow,
+ nullable=False,
+ )
+ deleted_at = Column(DateTime, nullable=True)
+
+
class WorkflowTemplateModel(Base):
"""
Tracks which workflows are marked as templates.
@@ -376,6 +410,8 @@ class WorkflowRunModel(Base):
sequential_key = Column(String, nullable=True)
run_with = Column(String, nullable=True) # 'agent' or 'code'
debug_session_id: Column = Column(String, nullable=True)
+ trigger_type = Column(String, nullable=True)
+ workflow_schedule_id = Column(String, nullable=True, index=True)
ai_fallback = Column(Boolean, nullable=True)
code_gen = Column(Boolean, nullable=True)
waiting_for_verification_code = Column(Boolean, nullable=False, default=False, server_default=sqlalchemy.false())
diff --git a/skyvern/forge/sdk/db/utils.py b/skyvern/forge/sdk/db/utils.py
index 23d1c99f6..32586c623 100644
--- a/skyvern/forge/sdk/db/utils.py
+++ b/skyvern/forge/sdk/db/utils.py
@@ -28,6 +28,7 @@ from skyvern.forge.sdk.db.models import (
WorkflowRunModel,
WorkflowRunOutputParameterModel,
WorkflowRunParameterModel,
+ WorkflowScheduleModel,
)
from skyvern.forge.sdk.encrypt import encryptor
from skyvern.forge.sdk.encrypt.base import EncryptMethod
@@ -42,6 +43,7 @@ from skyvern.forge.sdk.schemas.task_v2 import TaskV2
from skyvern.forge.sdk.schemas.tasks import Task, TaskStatus
from skyvern.forge.sdk.schemas.workflow_copilot import WorkflowCopilotChatMessage as WorkflowCopilotChatMessageSchema
from skyvern.forge.sdk.schemas.workflow_runs import WorkflowRunBlock
+from skyvern.forge.sdk.schemas.workflow_schedules import WorkflowSchedule
from skyvern.forge.sdk.workflow.models.parameter import (
AWSSecretParameter,
BitwardenLoginCredentialParameter,
@@ -735,3 +737,14 @@ def hydrate_action(action_model: ActionModel, empty_element_id: bool = False) ->
raise ValueError(f"Unsupported action type: {action_model.action_type}")
return action_class(**action_data)
+
+
+def convert_to_workflow_schedule(
+ workflow_schedule_model: WorkflowScheduleModel, debug_enabled: bool = False
+) -> WorkflowSchedule:
+ if debug_enabled:
+ LOG.debug(
+ "Converting WorkflowScheduleModel to WorkflowSchedule",
+ workflow_schedule_id=workflow_schedule_model.workflow_schedule_id,
+ )
+ return WorkflowSchedule.model_validate(workflow_schedule_model)
diff --git a/skyvern/forge/sdk/schemas/workflow_schedules.py b/skyvern/forge/sdk/schemas/workflow_schedules.py
new file mode 100644
index 000000000..d05ab1f30
--- /dev/null
+++ b/skyvern/forge/sdk/schemas/workflow_schedules.py
@@ -0,0 +1,72 @@
+from datetime import datetime
+from typing import Any
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class WorkflowSchedule(BaseModel):
+ model_config = ConfigDict(from_attributes=True)
+
+ workflow_schedule_id: str
+ organization_id: str
+ workflow_permanent_id: str
+ cron_expression: str
+ timezone: str
+ enabled: bool
+ parameters: dict[str, Any] | None = None
+ temporal_schedule_id: str | None = None
+ name: str | None = None
+ description: str | None = None
+ created_at: datetime
+ modified_at: datetime
+ deleted_at: datetime | None = None
+
+
+class OrganizationScheduleItem(BaseModel):
+ workflow_schedule_id: str
+ organization_id: str
+ workflow_permanent_id: str
+ workflow_title: str
+ cron_expression: str
+ timezone: str
+ enabled: bool
+ parameters: dict[str, Any] | None = None
+ name: str | None = None
+ description: str | None = None
+ next_run: datetime | None = None
+ created_at: datetime
+ modified_at: datetime
+
+
+class WorkflowScheduleCreateRequest(BaseModel):
+ cron_expression: str
+ timezone: str = "UTC"
+ enabled: bool = True
+ parameters: dict[str, Any] | None = None
+ name: str | None = None
+ description: str | None = None
+
+
+class WorkflowScheduleUpdateRequest(BaseModel):
+ cron_expression: str | None = None
+ timezone: str | None = None
+ enabled: bool | None = None
+ parameters: dict[str, Any] | None = None
+ name: str | None = None
+ description: str | None = None
+
+
+class WorkflowScheduleResponse(BaseModel):
+ schedule: WorkflowSchedule
+ next_runs: list[datetime] = Field(default_factory=list)
+
+
+class WorkflowScheduleListResponse(BaseModel):
+ schedules: list[WorkflowSchedule]
+
+
+class OrganizationScheduleListResponse(BaseModel):
+ schedules: list[OrganizationScheduleItem]
+ total_count: int
+ page: int
+ page_size: int
diff --git a/skyvern/forge/sdk/workflow/models/workflow.py b/skyvern/forge/sdk/workflow/models/workflow.py
index 343a5c67f..3adf7ebbc 100644
--- a/skyvern/forge/sdk/workflow/models/workflow.py
+++ b/skyvern/forge/sdk/workflow/models/workflow.py
@@ -5,6 +5,7 @@ from typing import Any, List
from pydantic import BaseModel, field_validator
from typing_extensions import deprecated
+from skyvern.forge.sdk.db.enums import WorkflowRunTriggerType
from skyvern.forge.sdk.schemas.files import FileInfo
from skyvern.forge.sdk.schemas.task_v2 import TaskV2
from skyvern.forge.sdk.workflow.exceptions import (
@@ -176,6 +177,8 @@ class WorkflowRun(BaseModel):
sequential_key: str | None = None
ai_fallback: bool | None = None
code_gen: bool | None = None
+ trigger_type: WorkflowRunTriggerType | None = None
+ workflow_schedule_id: str | None = None
queued_at: datetime | None = None
started_at: datetime | None = None
diff --git a/uv.lock b/uv.lock
index 1a5a8b99b..8de120fa4 100644
--- a/uv.lock
+++ b/uv.lock
@@ -1413,7 +1413,7 @@ wheels = [
[[package]]
name = "google-cloud-aiplatform"
-version = "1.136.0"
+version = "1.141.0"
source = { registry = "https://pypi.org/simple" }
dependencies = [
{ name = "docstring-parser" },
@@ -1429,9 +1429,9 @@ dependencies = [
{ name = "pydantic" },
{ name = "typing-extensions" },
]
-sdist = { url = "https://files.pythonhosted.org/packages/7f/9c/38ce04e3ef89034c736320a27b4a6e3171ca2f3fb56d38f76a310c745d14/google_cloud_aiplatform-1.136.0.tar.gz", hash = "sha256:01e64a0d0861486e842bf7e904077c847bcc1b654a29883509d57476de915b7d", size = 9946722, upload-time = "2026-02-04T16:28:12.903Z" }
+sdist = { url = "https://files.pythonhosted.org/packages/ac/dc/1209c7aab43bd7233cf631165a3b1b4284d22fc7fe7387c66228d07868ab/google_cloud_aiplatform-1.141.0.tar.gz", hash = "sha256:e3b1cdb28865dd862aac9c685dfc5ac076488705aba0a5354016efadcddd59c6", size = 10152688, upload-time = "2026-03-10T22:20:08.692Z" }
wheels = [
- { url = "https://files.pythonhosted.org/packages/55/e8/f317dc96c9c73846dd3e4d16691cc5f248801f46354d9d57f2c67fd67413/google_cloud_aiplatform-1.136.0-py2.py3-none-any.whl", hash = "sha256:5c829f002b7b673dcd0e718f55cc0557b571bd10eb5cdb7882d72916cfbf8c0e", size = 8203924, upload-time = "2026-02-04T16:28:10.343Z" },
+ { url = "https://files.pythonhosted.org/packages/6a/fc/428af69a69ff2e477e7f5e12d227b31fe5790f1a8234aacd54297f49c836/google_cloud_aiplatform-1.141.0-py2.py3-none-any.whl", hash = "sha256:6bd25b4d514c40b8181ca703e1b313ad6d0454ab8006fc9907fb3e9f672f31d1", size = 8358409, upload-time = "2026-03-10T22:20:04.871Z" },
]
[[package]]