View as Markdown
VisualPing icon

VisualPing ACTION

Create A New Job

Creates a new job that will belong to a given user or workspace. See the docs here
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's VisualPing account once, then configure and run Create A New Job 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: "visualping-create-job",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    visualping: { authProvisionId: "apn_xxxxxxx" },
    email: "Email",
    business: true,
  },
})

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 A New Job inputs
Property Type Description
email Email string
An email for internal use.
Optional
business Business boolean
For internal use.
Optional
locale Locale string
Locale for internal use.
Optional
siteReferer Site Referer string
Site Referer for internal use.
Optional
adCampaign Ad Campaign object
For internal use.
Optional
origin Origin string
For internal use.
Optional
contentType Content Type string
For internal use.
Optional
url URL string
Url of the web page monitored by this job.
Required
description Description string
Job Description
Required
mode Mode string
Job mode
Required
active Active boolean
Whether the job is active or paused.
Required
interval Interval string
Job's crawling interval expressed in minutes. Examples: 5, 15, 1440...
Required
trigger Trigger string
Job's diff detection trigger expressed in percents. Examples: 0.1, 25...
Required
targetDevice Target Device string
1 for regular desktop crawling of a specific area (used typically in conjunction with a crop area), 4 for full page desktop crawling (mostly used with text jobs), 3 for desktop crawling with special fold extractions. 2 for mobile.
Required
proxy Proxy string
String code representing the optional proxy to use for this job. Contact Visualping for details.
Optional
fixedProxyAlias Fixed Proxy Alias string
For internal use.
Optional
xpath Xpath string
Optional xpath representing the root web element to consider for this job.
Optional
renderer Renderer string
For internal use.
Optional
disableJS Disable JS boolean
For internal use.
Optional
pageHeight Page Height string
For internal use.
Optional
waitTime Wait Time integer
Number of seconds to wait the crawling and before applying any actions on the wab page.
Optional
preactionsActive Preactions Active boolean
Whether Preactions is active or not.
Optional
preactionsObjects Preactions Objects any
Array of LegacyJobPreAction objects.
Optional
advancedScheduleActive Advanced Schedule Active boolean
Whether advanced schedule is active or not.
Optional
multicheckEnabled Multicheck Enabled string
For internal use.
Optional
enableSmsAlert Enable SMS Alert boolean
Used to enable sms notifications for the considered job. Typically false.
Required
enableEmailAlert Enable Email Alert boolean
Used to enable email notifications for the considered job. Typically false.
Required
useSlackNotification Use Slack Notification boolean
If this job uses slack notification.
Required
useTeamsNotification Use Teams Notification boolean
If this job uses teams notification.
Required
useWebhookNotification Use Webhook Notification boolean
If this job uses webhook notification.
Required
useDiscordNotification Use Discord Notification boolean
If this job uses discord notification.
Required
useSlackAppNotification Use Slack App Notification boolean
If this job uses slack app notification.
Required
workspaceId Workspace ID string
The workspace ID
Required Dynamic

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
visualping-create-job
Version
0.0.3
App
VisualPing
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes