View as Markdown
VisualPing icon

VisualPing ACTION

Get Job Details By Id

Gets the full details of one Visualping job by id — schedule, trigger, notification config, crop region, and change-detection history. Use Find Jobs first to locate the job id if you don't already have it. Example: to confirm a job's check interval after creating it, call with the jobId returned by Create A New Job → returns the full job object including interval, trigger, mode, and active. Pass fields to return only the fields you need. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's VisualPing account once, then configure and run Get Job Details By Id 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-get-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)

SCHEMA

Inputs

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

Get Job Details By Id inputs
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
fields Fields string[]
Field names to return (id is always included). Omit to get the full job object (today's default output). A useful compact set: id, url, description, mode, active, interval, trigger, target_device, workspaceId.
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-get-job
Version
0.1.0
App
VisualPing
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes