View as Markdown
Oxylabs icon

Oxylabs ACTION

Create Schedule

Create a schedule for a scraping job. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Oxylabs account once, then configure and run Create Schedule from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "oxylabs-create-schedule",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    oxylabs: { authProvisionId: "apn_xxxxxxx" },
    chron: "Cron Expression",
    items: ["Items"],
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Schedule inputs
Property Type Description
chron Cron Expression string
Cron schedule expression. It determines how often the submitted schedule will run. E.g. 0 3 * * 1. Read more here and here.
Required
items Items string[]
List of Scraper APIs job parameter sets that should be executed as part of the schedule. E.g. [{"source": "universal", "url": "https://ip.oxylabs.io"}] See the documentation for more information.
Required
endTime End Time string
The time at which the schedule should stop running. E.g. 2032-12-21 12:34:45
Required

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
oxylabs-create-schedule
Version
0.0.4
App
Oxylabs
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes