View as Markdown
VisualPing icon

VisualPing ACTION

Create A New Job

Creates a new Visualping monitoring job that checks a web page on a schedule and alerts on a detected change. Use for requests like "monitor this page for changes" or "watch this URL and tell me when the price changes". Set active: false to create the job paused (useful for testing before it starts consuming your plan's active-job quota). Example: to watch a pricing page for any change every hour, call with url="https://example.com/pricing", mode="VISUAL", interval="60", trigger="5", targetDevice="4", active=true → returns the created job object with its new id, which you'll need for Get Job Details By Id, Update Job, or Delete Job. For mode="TEXT" jobs, also set keywordAction and keywords to watch for specific text changes. For AREA crawling (targetDevice 1 or 3), also set cropX/cropY/cropWidth/cropHeight. See the documentation
  • 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
keywordAction Keyword Action string
Keyword detection mode. Only used when mode is TEXT.
Optional
keywords Keywords string[]
List of keywords to detect. Only used when mode is TEXT.
Optional
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... Only specific values are accepted (the API rejects others with "Frequency not available"), and the plan on the connected account sets a floor — e.g. a free/personal-tier account was observed rejecting anything below 60. If a request fails this way, retry with 60 or higher rather than guessing a nearby value.
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
cropX Crop X integer
Start X position of the crop. Only used when targetDevice is 1 (Area) or 3 (Specific Fold).
Optional
cropY Crop Y integer
Start Y position of the crop. Only used when targetDevice is 1 (Area) or 3 (Specific Fold).
Optional
cropWidth Crop Width integer
The width of the crop. Only used when targetDevice is 1 (Area) or 3 (Specific Fold).
Optional
cropHeight Crop Height integer
The height of the crop. Only used when targetDevice is 1 (Area) or 3 (Specific Fold).
Optional
proxyId Proxy ID integer
Numeric id of a proxy to route this job's checks through. There is no self-service way to obtain this id — it's assigned by Visualping support. Contact Visualping to request one, then pass the numeric id they provide (e.g. 1042). Leave blank if you don't have one.
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
stopTime Stop Time integer
The hour to stop monitoring (0-24). Only used when advancedScheduleActive is true.
Optional
startTime Start Time integer
The hour to start monitoring (0-24). Only used when advancedScheduleActive is true.
Optional
activeDays Active Days integer[]
List of days from 1 to 7 the schedule is active. Only used when advancedScheduleActive is true.
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
slackUrl Slack URL string
The URL to the slack notification. Only used when useSlackNotification is true.
Optional
slackChannels Slack Channels string[]
A list of slack's channels. Only used when useSlackNotification is true.
Optional
useTeamsNotification Use Teams Notification boolean
If this job uses teams notification.
Required
teamsUrl Teams URL string
The URL to the teams notification. Only used when useTeamsNotification is true.
Optional
useWebhookNotification Use Webhook Notification boolean
If this job uses webhook notification.
Required
webhookUrl Webhook URL string
The URL to the webhook notification. Only used when useWebhookNotification is true.
Optional
useDiscordNotification Use Discord Notification boolean
If this job uses discord notification.
Required
discordUrl Discord URL string
The URL to the discord notification. Only used when useDiscordNotification is true.
Optional
useSlackAppNotification Use Slack App Notification boolean
If this job uses slack app notification.
Required
slackAppUrl Slack App URL string
The URL to the slack app notification. Only used when useSlackAppNotification is true.
Optional
slackAppChannels Slack App Channels string[]
A list of slack app's channels. Only used when useSlackAppNotification is true.
Optional
workspaceId Workspace ID integer
The workspace's numeric id. Use List Workspace ID Options to discover valid ids and names for the connected account. Example: to work in the "Marketing" workspace, call that tool first, then pass its id here, e.g. 77421.
Optional

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
1.0.0
App
VisualPing
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes