VisualPing ACTION
Update Job
Updates one or more settings of an existing Visualping job — schedule, trigger, notification config, crop region, and more. Only the fields you pass are changed; everything else on the job stays as-is. Use Find Jobs or Get Job Details By Id first to confirm the
jobId and current settings if you're not certain which job the user means. Example: to pause a noisy job, call with just jobId="482913" and active=false → returns the updated job object with active: false. See the documentation- Action
- Writes data
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's VisualPing account once, then configure and run Update 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-update-job",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
visualping: { authProvisionId: "apn_xxxxxxx" },
workspaceId: 10,
jobId: "Job ID",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "visualping-update-job",
"configured_props": {
"visualping": { "authProvisionId": "apn_xxxxxxx" },
"workspaceId": 10,
"jobId": "Job ID"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "visualping",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "visualping-update-job",
arguments: {
workspaceId: 10,
jobId: "Job ID",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
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 |
jobId Job ID | string | The job's numeric id. Use Find Jobs to discover valid ids (each result includes id and url) — search by fullTextSearchFilter (matches URL or description) to locate a specific job. Example: after finding a job for https://example.com/pricing, pass its id here, e.g. 482913. Required |
organisationId Organisation Id | integer | Unique ID of the organisation. Only applies to business/team accounts — use List Workspace ID Options to discover it (returned alongside workspace ids when the account belongs to an organisation). Leave blank on a personal-tier account: it has no organisation, and this field is expected to be empty rather than guessed. Optional |
url URL | string | Url of the web page monitored by this job. Optional |
description Description | string | Job Description Optional |
mode Mode | string | Job mode Optional |
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. Optional |
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. Optional |
trigger Trigger | string | Job's diff detection trigger expressed in percents. Examples: 0.1, 25... 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 |
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. Optional |
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 |
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. Optional |
enableEmailAlert Enable Email Alert | boolean | Used to enable email notifications for the considered job. Typically false. Optional |
useSlackNotification Use Slack Notification | boolean | If this job uses slack notification. Optional |
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. Optional |
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. Optional |
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. Optional |
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. Optional |
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 |
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-update-job
- Version
- 1.0.0
- App
- VisualPing
- Authentication
- OAuth
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗