Create and Run Task with Skyvern API on Custom Interval from Schedule API

Pipedream makes it easy to connect APIs for Skyvern, Schedule and 2,400+ other apps remarkably fast.

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

Create and Run Task with the Skyvern API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Schedule trigger and Skyvern action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Custom Interval trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Create and Run Task action
1. Connect your Skyvern account
2. Configure URL
3. Optional- Configure Navigation Goal
4. Optional- Configure Data Extraction Goal
5. Optional- Configure Navigation Payload
6. Optional- Configure Webhook Callback URL
7. Optional- Configure Extracted Information Schema
8. Optional- Configure TOTP Verification URL
9. Optional- Configure TOTP Identifier
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

Custom Interval on Schedule

Description:Trigger your workflow every N hours, minutes or seconds.

Version:0.0.2

Key:schedule-custom-interval

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

import schedule from "../../schedule.app.mjs";

export default {
  name: "Custom Interval",
  version: "0.0.2",
  key: "schedule-custom-interval",
  type: "source",
  description: "Trigger your workflow every N hours, minutes or seconds.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
    },
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Create and Run Task on Skyvern

Description:Create a new task and run it instantly in Skyvern. Useful for one-off automations. [See the documentation](https://docs.skyvern.com/)

Version:0.0.1

Key:skyvern-create-run-task

View on GitHub

Action Code#

import { parseObject } from "../../common/utils.mjs";
import skyvern from "../../skyvern.app.mjs";

export default {
  key: "skyvern-create-run-task",
  name: "Create and Run Task",
  description: "Create a new task and run it instantly in Skyvern. Useful for one-off automations. [See the documentation](https://docs.skyvern.com/)",
  version: "0.0.1",
  type: "action",
  props: {
    skyvern,
    url: {
      type: "string",
      label: "URL",
      description: "It must be a http or https URL.",
    },
    navigationGoal: {
      type: "string",
      label: "Navigation Goal",
      description: "The prompt that tells the agent what the user-facing goal is. This is the guiding light for the LLM as it navigates a particular website / sitemap to achieve this specified goal.",
      optional: true,
    },
    dataExtractionGoal: {
      type: "string",
      label: "Data Extraction Goal",
      description: "The prompt that instructs the agent to extract information once the agent has achieved its **User Goal**.",
      optional: true,
    },
    navigationPayload: {
      type: "object",
      label: "Navigation Payload",
      description: "JSON-formatted payload with any \"facts\" or information that would help the agent perform its job. In the case of navigating an insurance quote, this payload would include any user information to help fill out the insurance flow such as date of birth, or age they got their license, and so on. This can include nested information, and the formatting isn't validated.",
      optional: true,
    },
    webhookCallbackUrl: {
      propDefinition: [
        skyvern,
        "webhookCallbackUrl",
      ],
      description: "The callback URL once our system is finished processing this async task.",
      optional: true,
    },
    extractedInformationSchema: {
      type: "object",
      label: "Extracted Information Schema",
      description: "Used to enforce a JSON schema spec to be enforced in the data_extraction_goal. Similar to [https://json-schema.org/](https://json-schema.org/) definition.",
      optional: true,
    },
    totpVerificationUrl: {
      type: "string",
      label: "TOTP Verification URL",
      description: "The URL of your TOTP endpoint. If this field is provided, Skyvern will call the URL to fetch the TOTP/2FA/MFA code when needed.",
      optional: true,
    },
    totpIdentifier: {
      type: "string",
      label: "TOTP Identifier",
      description: "The email address or the phone number which receives the TOTP/2FA/MFA code. If this field is provided, Skyvern will fetch the code that is pushed to [Skyvern's TOTP API](https://docs.skyvern.com/running-tasks/advanced-features#push-code-to-skyvern).",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.skyvern.createAndRunTask({
      $,
      data: {
        url: this.url,
        navigation_goal: this.navigationGoal,
        data_extraction_goal: this.dataExtractionGoal,
        navigation_payload: parseObject(this.navigationPayload),
        webhook_callback_url: this.webhookCallbackUrl,
        proxyLocation: "RESIDENTIAL",
        extracted_information_schema: parseObject(this.extractedInformationSchema),
        totp_verification_url: this.totpVerificationUrl,
        totp_identifier: this.totpIdentifier,
      },
    });
    $.export("$summary", `Created and ran task with ID ${response.task_id}`);
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Skyvern	`skyvern`	`app`	This component uses the Skyvern app.
URL	`url`	`string`	It must be a http or https URL.
Navigation Goal	`navigationGoal`	`string`	The prompt that tells the agent what the user-facing goal is. This is the guiding light for the LLM as it navigates a particular website / sitemap to achieve this specified goal.
Data Extraction Goal	`dataExtractionGoal`	`string`	The prompt that instructs the agent to extract information once the agent has achieved its User Goal.
Navigation Payload	`navigationPayload`	`object`	JSON-formatted payload with any "facts" or information that would help the agent perform its job. In the case of navigating an insurance quote, this payload would include any user information to help fill out the insurance flow such as date of birth, or age they got their license, and so on. This can include nested information, and the formatting isn't validated.
Webhook Callback URL	`webhookCallbackUrl`	`string`	The callback URL once our system is finished processing this async task.
Extracted Information Schema	`extractedInformationSchema`	`object`	Used to enforce a JSON schema spec to be enforced in the data_extraction_goal. Similar to https://json-schema.org/ definition.
TOTP Verification URL	`totpVerificationUrl`	`string`	The URL of your TOTP endpoint. If this field is provided, Skyvern will call the URL to fetch the TOTP/2FA/MFA code when needed.
TOTP Identifier	`totpIdentifier`	`string`	The email address or the phone number which receives the TOTP/2FA/MFA code. If this field is provided, Skyvern will fetch the code that is pushed to Skyvern's TOTP API.

Action Authentication#

Skyvern uses API keys for authentication. When you connect your Skyvern account, Pipedream securely stores the keys so you can easily authenticate to Skyvern APIs in both code and no-code steps.