Skyvern/docs/cloud/building-workflows/run-a-workflow.mdx

137 lines
5.1 KiB
Text

---
title: Running Workflows
subtitle: Execute workflows, fill parameters, and track status
description: Execute workflows from the Skyvern Cloud UI editor or workflows list, fill in runtime parameters, configure run settings like proxy and webhook, and monitor live execution.
slug: cloud/run-a-workflow
keywords:
- execute
- fill parameters
- run settings
- proxy
- webhook
- cancel
- retry
- live execution
---
Once you've built and saved a workflow in the Cloud UI, you can run it from the editor or the workflows list. Each run creates an independent execution with its own status, logs, and output.
You can also trigger workflows programmatically from your code. See [Run from Code](/cloud/building-workflows/run-from-code) for the SDK and API approach.
## Starting a run
Two ways to start:
1. **From the editor**: Click the **Run** button (play icon) in the header bar. The editor saves your workflow first.
<img src="/images/cloud/run-wf-1.png" alt="Workflow editor with the Run button highlighted in the header bar" />
2. **From the workflows list**: Click the **play icon** on the workflow's row.
<img src="/images/cloud/run-wf-2.png" alt="Workflows list page with play icon to start a run from the list" />
Both take you to the parameters page where you fill in runtime values before the run starts.
## Filling in parameters
The parameters page shows all [workflow parameters](/cloud/building-workflows/add-parameters) defined in the editor. Fill in a value for each one, or leave them at their defaults. Parameters without defaults must be filled in before running.
<img src="/images/cloud/run-wf-3.png" alt="Parameters page showing input fields and settings before starting a workflow run" />
## Run settings
Below the parameters, you can configure settings for this specific run:
| Setting | Description |
|---------|-------------|
| **Proxy Location** | Route browser traffic through a proxy in a specific country. Default: US Residential. |
| **Webhook Callback URL** | URL that receives a POST request when the run completes |
| **Max Screenshot Scrolls** | Override screenshot scroll depth for this run |
| **Extra HTTP Headers** | Custom headers included in all browser requests (JSON) |
| **CDP Address** | Connect to your own browser for local development |
<Frame>
<img src="/images/cloud/run-wf-6.png" alt="Run settings showing webhook callback URL, proxy location, and AI fallback options" />
</Frame>
<br/>
<Frame>
<img src="/images/cloud/run-wf-7.png" alt="Advanced run settings showing browser session ID, browser address, extra HTTP headers, and max screenshot scrolls" />
</Frame>
---
## Monitoring a run
After clicking **Run**, you're taken to the live execution view, the same interface described in [Watching Live Execution](/cloud/getting-started/monitor-a-run).
For workflows, the left panel also shows a **block timeline**: a list of all blocks in the workflow. Completed blocks show a checkmark. The currently executing block is highlighted.
<img src="/images/cloud/workflow-run-timeline.png" alt="Workflow run block timeline" />
---
## Run statuses
| Status | Description |
|--------|-------------|
| `created` | Run initialized |
| `queued` | Waiting for an available browser |
| `running` | Blocks are executing |
| `completed` | All blocks finished successfully |
| `failed` | A block failed and the workflow stopped |
| `canceled` | You canceled the run |
| `timed_out` | The run exceeded its time limit |
| `terminated` | The run was terminated by the system |
---
## Viewing results
After a run completes, open it from **Runs** in the sidebar. The run detail page shows:
- **Block-by-block results**: Each block's output, status, and execution time
- **Recording**: Full video replay of the browser session
- **Parameters**: The values you submitted for this run
<img src="/images/cloud/run-wf-8.png" alt="Completed workflow run showing extracted data, output tabs, and block timeline" />
See [Reviewing results](/cloud/getting-started/monitor-a-run#reviewing-results) for details on the Actions, Recording, Parameters, and Diagnostics tabs.
---
## Canceling a run
Click the **Cancel** button during execution. A confirmation dialog appears. The run moves to `canceled` status and any configured webhook fires.
---
## Run history
Access past runs from two places:
1. **Runs** in the left sidebar: shows all runs across all workflows
<img src="/images/cloud/run-wf-4.png" alt="Run History page in the sidebar showing all past runs with status and duration" />
2. Go to the **History** button (clock icon) in the workflow editor: shows runs for this specific workflow
<img src="/images/cloud/run-wf-5.png" alt="Past Runs view for a specific workflow showing run statuses and timestamps" />
---
## What's next
<CardGroup cols={2}>
<Card
title="Build a Workflow"
icon="pen-to-square"
href="/cloud/building-workflows/build-a-workflow"
>
Create and edit workflows in the visual editor
</Card>
<Card
title="Block Reference"
icon="cube"
href="/cloud/building-workflows/configure-blocks"
>
Configuration fields for every block type
</Card>
</CardGroup>