View as Markdown
VisualPing icon

VisualPing ACTION

Update Job

Update an existing job. See the docs here
  • Action
  • Writes data
  • Destructive
  • 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: "Workspace ID",
    jobId: "Job ID",
  },
})

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.

Update Job inputs
Property Type Description
workspaceId Workspace ID string
The workspace ID
Required Dynamic
jobId Job ID string
The job ID
Required Dynamic
organisationId Organisation Id string
Unique ID of the organisation.
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
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...
Optional
trigger Trigger string
Job's diff detection trigger expressed in percents. Examples: 0.1, 25...
Optional
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
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
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.
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
useTeamsNotification Use Teams Notification boolean
If this job uses teams notification.
Optional
useWebhookNotification Use Webhook Notification boolean
If this job uses webhook notification.
Optional
useDiscordNotification Use Discord Notification boolean
If this job uses discord notification.
Optional
useSlackAppNotification Use Slack App Notification boolean
If this job uses slack app notification.
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
0.0.3
App
VisualPing
Authentication
OAuth
Read-only
No
Destructive
Yes
Open world
Yes