Skip to content

Automate browser based workflows with AI

feat: add webhook trigger endpoint for workflows (SKY-8541) (#5292)

Aaron Perez5eb19d9d70f6
diff --git a/skyvern/client/types/workflow_run_trigger_type.py b/skyvern/client/types/workflow_run_trigger_type.py
index 53f01e067..2d04cf802 100644
--- a/skyvern/client/types/workflow_run_trigger_type.py
+++ b/skyvern/client/types/workflow_run_trigger_type.py
@@ -2,4 +2,4 @@
import typing
-WorkflowRunTriggerType = typing.Union[typing.Literal["manual", "api", "scheduled"], typing.Any]
+WorkflowRunTriggerType = typing.Union[typing.Literal["manual", "api", "scheduled", "webhook"], typing.Any]
diff --git a/skyvern/forge/sdk/db/enums.py b/skyvern/forge/sdk/db/enums.py
index a0267d16f..bc624a355 100644
--- a/skyvern/forge/sdk/db/enums.py
+++ b/skyvern/forge/sdk/db/enums.py
@@ -16,6 +16,15 @@ class TaskType(StrEnum):
class WorkflowRunTriggerType(StrEnum):
+ """How a workflow run was initiated.
+
+ - manual: User clicked "Run" in the UI
+ - api: Direct API call to the run endpoint
+ - scheduled: Triggered by a cron schedule
+ - webhook: Triggered by an external system via the webhook endpoint
+ """
+
manual = "manual"
api = "api"
scheduled = "scheduled"
+ webhook = "webhook"
diff --git a/skyvern/services/workflow_service.py b/skyvern/services/workflow_service.py
index a1798d845..5ff20d21f 100644
--- a/skyvern/services/workflow_service.py
+++ b/skyvern/services/workflow_service.py
@@ -5,6 +5,7 @@ from fastapi import BackgroundTasks, Request
from skyvern.config import settings
from skyvern.forge import app
+from skyvern.forge.sdk.db.enums import WorkflowRunTriggerType
from skyvern.forge.sdk.executor.factory import AsyncExecutorFactory
from skyvern.forge.sdk.schemas.organizations import Organization
from skyvern.forge.sdk.workflow.exceptions import InvalidTemplateWorkflowPermanentId
@@ -25,6 +26,7 @@ async def prepare_workflow(
debug_session_id: str | None = None,
code_gen: bool | None = None,
parent_workflow_run_id: str | None = None,
+ trigger_type: WorkflowRunTriggerType | None = None,
) -> WorkflowRun:
"""
Prepare a workflow to be run.
@@ -44,6 +46,7 @@ async def prepare_workflow(
debug_session_id=debug_session_id,
code_gen=code_gen,
parent_workflow_run_id=parent_workflow_run_id,
+ trigger_type=trigger_type,
)
workflow = await app.WORKFLOW_SERVICE.get_workflow_by_permanent_id(
@@ -79,6 +82,7 @@ async def run_workflow(
block_labels: list[str] | None = None,
block_outputs: dict[str, t.Any] | None = None,
parent_workflow_run_id: str | None = None,
+ trigger_type: WorkflowRunTriggerType | None = None,
) -> WorkflowRun:
workflow_run = await prepare_workflow(
workflow_id=workflow_id,
@@ -89,6 +93,7 @@ async def run_workflow(
max_steps=max_steps,
request_id=request_id,
parent_workflow_run_id=parent_workflow_run_id,
+ trigger_type=trigger_type,
)
await AsyncExecutorFactory.get_executor().execute_workflow(