docs: new integrations section with screen recordings and videos + restructuring (#4705)
Co-authored-by: Kunal Mishra <kunalm2345@gmail.com>
This commit is contained in:
118
docs/integrations/workato.mdx
Normal file
118
docs/integrations/workato.mdx
Normal file
@@ -0,0 +1,118 @@
|
||||
---
|
||||
title: Workato
|
||||
subtitle: Run browser automations in your Workato recipes
|
||||
slug: integrations/workato
|
||||
---
|
||||
|
||||
Connect Skyvern to Workato's enterprise automation platform. Trigger browser automations from any recipe, or route Skyvern's results into downstream actions.
|
||||
|
||||
## Available Actions
|
||||
|
||||
- **Create and Run Task** — Run an automation using **Skyvern 1.0** (simple, single-step goals)
|
||||
- **Create and Run Task V2** — Run an automation using **Skyvern 2.0** (complex, multi-step goals)
|
||||
- **Run a Workflow** — Run a pre-built Skyvern workflow with parameters
|
||||
- **Get Task / Get Task V2** — Retrieve results from a previously run task
|
||||
- **Get Workflow** — Retrieve results from a previously run workflow
|
||||
|
||||
## Setup
|
||||
|
||||
<Steps>
|
||||
<Step title="Install the connector">
|
||||
Go to the Community Library tab, search for "Skyvern" under custom connectors, and click **Install** → "release latest version".
|
||||
|
||||
<Frame>
|
||||
<img src="/images/workato/s1img1.png" alt="Search for Skyvern in Workato Community Library" />
|
||||
</Frame>
|
||||
<Frame>
|
||||
<img src="/images/workato/s1img2.png" alt="Skyvern connector page in Workato" />
|
||||
</Frame>
|
||||
</Step>
|
||||
|
||||
<Step title="Add Skyvern to your recipe">
|
||||
Create a new recipe or edit an existing one, add an action, and search for "Skyvern".
|
||||
|
||||
<Frame>
|
||||
<img src="/images/workato/s1img4.png" alt="Add Skyvern action to Workato recipe" />
|
||||
</Frame>
|
||||
<Frame>
|
||||
<img src="/images/workato/s1img6.png" alt="List of available Skyvern actions in Workato" />
|
||||
</Frame>
|
||||
</Step>
|
||||
|
||||
<Step title="Connect your account">
|
||||
Paste your API key from [Settings](https://app.skyvern.com/settings/api-keys) and save the connection.
|
||||
|
||||
<Frame>
|
||||
<img src="/images/workato/s1img7.png" alt="Connect Skyvern account in Workato" />
|
||||
</Frame>
|
||||
</Step>
|
||||
|
||||
<Step title="Configure">
|
||||
Fill in the fields for your chosen action. See the field reference below.
|
||||
</Step>
|
||||
|
||||
<Step title="Test">
|
||||
Click **Save** then **Test recipe** and monitor progress in your [Skyvern dashboard](https://app.skyvern.com).
|
||||
|
||||
<Frame>
|
||||
<img src="/images/workato/s3img1.png" alt="Test Workato recipe with Skyvern" />
|
||||
</Frame>
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
## Field reference
|
||||
|
||||
### Create and Run a Task
|
||||
|
||||
- **URL** (required) — The starting page for the automation
|
||||
- **Navigation Goal** — What Skyvern should do on the page. Omit if only extracting data.
|
||||
- **Data Extraction Goal** — What data to pull from the page
|
||||
- **Navigation Payload** — JSON input data for forms. Lets you reuse the same task with different data.
|
||||
- **Extracted Information Schema** — JSON schema defining the shape of extracted data
|
||||
- **Webhook Callback URL** — URL to notify when the task finishes
|
||||
- **Max Steps** — Cap the number of steps to control costs
|
||||
|
||||
<Note>
|
||||
The navigation goal describes what to do *after* loading the URL. Don't include "go to website X" — use the URL field instead.
|
||||
</Note>
|
||||
|
||||
<Frame>
|
||||
<img src="/images/workato/s2img1.png" alt="Configure task fields in Workato" />
|
||||
</Frame>
|
||||
|
||||
### Run a Workflow
|
||||
|
||||
First, create your workflow in the [Skyvern UI](https://app.skyvern.com).
|
||||
|
||||
- **Workflow** (required) — Select the workflow to run
|
||||
- **Parameters** — Fill in any parameters defined in your workflow
|
||||
|
||||
<Frame>
|
||||
<img src="/images/workato/s5img1.png" alt="Select workflow in Workato" />
|
||||
</Frame>
|
||||
|
||||
### Get Task / Workflow
|
||||
|
||||
Retrieve the details of a completed run.
|
||||
|
||||
- **Task ID** (required) — Starts with `tsk_`
|
||||
- **Workflow Run ID** (required) — Starts with `wr_`
|
||||
|
||||
## Next steps
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
title="Build Workflows"
|
||||
icon="diagram-project"
|
||||
href="/cloud/manage-workflows"
|
||||
>
|
||||
Create reusable multi-step automations in Skyvern
|
||||
</Card>
|
||||
<Card
|
||||
title="Use Webhooks"
|
||||
icon="webhook"
|
||||
href="/going-to-production/webhooks"
|
||||
>
|
||||
Get notified when tasks complete
|
||||
</Card>
|
||||
</CardGroup>
|
||||
Reference in New Issue
Block a user