← VisualPing

Create A New Job with VisualPing API

Pipedream makes it easy to connect APIs for VisualPing and 2,400+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Create A New Job with the VisualPing API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Create A New Job with the VisualPing API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Create A New Job action
    1. Connect your VisualPing account
    2. Optional- Configure Email
    3. Optional- Configure Business
    4. Optional- Configure Locale
    5. Optional- Configure Site Referer
    6. Optional- Configure Ad Campaign
    7. Optional- Configure Origin
    8. Optional- Configure Content Type
    9. Configure URL
    10. Configure Description
    11. Select a Mode
    12. Configure Active
    13. Configure Interval
    14. Configure Trigger
    15. Select a Target Device
    16. Optional- Configure Proxy
    17. Optional- Configure Fixed Proxy Alias
    18. Optional- Configure Xpath
    19. Optional- Configure Renderer
    20. Optional- Configure Disable JS
    21. Optional- Configure Page Height
    22. Optional- Configure Wait Time
    23. Optional- Configure Preactions Active
    24. Optional- Configure Preactions Objects
    25. Optional- Configure Advanced Schedule Active
    26. Optional- Configure Multicheck Enabled
    27. Configure Enable SMS Alert
    28. Configure Enable Email Alert
    29. Configure Use Slack Notification
    30. Configure Use Teams Notification
    31. Configure Use Webhook Notification
    32. Configure Use Discord Notification
    33. Configure Use Slack App Notification
    34. Select a Workspace ID
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Create A New Job with VisualPing API on New Requests from HTTP / Webhook API
HTTP / Webhook + VisualPing
 
Try it
Create A New Job with VisualPing API on New Submission from Typeform API
Typeform + VisualPing
 
Try it
Create A New Job with VisualPing API on New Submission (Instant) from Jotform API
Jotform + VisualPing
 
Try it
Create A New Job with VisualPing API on New Custom Webhook Events from Stripe API
Stripe + VisualPing
 
Try it
Create A New Job with VisualPing API on New Scheduled Tasks from Pipedream API
Pipedream + VisualPing
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Create A New Job on VisualPing
Description:Creates a new job that will belong to a given user or workspace. [See the docs here](https://develop.api.visualping.io/doc.html#tag/Jobs/paths/~1v2~1jobs/post)
Version:0.0.2
Key:visualping-create-job

Code

import visualping from "../../app/visualping.app.mjs";

export default {
  key: "visualping-create-job",
  name: "Create A New Job",
  version: "0.0.2",
  description: "Creates a new job that will belong to a given user or workspace. [See the docs here](https://develop.api.visualping.io/doc.html#tag/Jobs/paths/~1v2~1jobs/post)",
  type: "action",
  props: {
    visualping,
    email: {
      propDefinition: [
        visualping,
        "email",
      ],
      optional: true,
    },
    business: {
      propDefinition: [
        visualping,
        "business",
      ],
      optional: true,
    },
    locale: {
      propDefinition: [
        visualping,
        "locale",
      ],
      optional: true,
    },
    siteReferer: {
      propDefinition: [
        visualping,
        "siteReferer",
      ],
      optional: true,
    },
    adCampaign: {
      propDefinition: [
        visualping,
        "adCampaign",
      ],
      optional: true,
    },
    origin: {
      propDefinition: [
        visualping,
        "origin",
      ],
      optional: true,
    },
    contentType: {
      propDefinition: [
        visualping,
        "contentType",
      ],
      optional: true,
    },
    url: {
      propDefinition: [
        visualping,
        "url",
      ],
    },
    description: {
      propDefinition: [
        visualping,
        "description",
      ],
    },
    mode: {
      propDefinition: [
        visualping,
        "mode",
      ],
      reloadProps: true,
    },
    active: {
      propDefinition: [
        visualping,
        "active",
      ],
    },
    interval: {
      propDefinition: [
        visualping,
        "interval",
      ],
    },
    trigger: {
      propDefinition: [
        visualping,
        "trigger",
      ],
    },
    targetDevice: {
      propDefinition: [
        visualping,
        "targetDevice",
      ],
      reloadProps: true,
    },
    proxy: {
      propDefinition: [
        visualping,
        "proxy",
      ],
      optional: true,
    },
    fixedProxyAlias: {
      propDefinition: [
        visualping,
        "fixedProxyAlias",
      ],
      optional: true,
    },
    xpath: {
      propDefinition: [
        visualping,
        "xpath",
      ],
      optional: true,
    },
    renderer: {
      propDefinition: [
        visualping,
        "renderer",
      ],
      optional: true,
    },
    disableJS: {
      propDefinition: [
        visualping,
        "disableJS",
      ],
      optional: true,
    },
    pageHeight: {
      propDefinition: [
        visualping,
        "pageHeight",
      ],
      optional: true,
    },
    waitTime: {
      propDefinition: [
        visualping,
        "waitTime",
      ],
      optional: true,
    },
    preactionsActive: {
      propDefinition: [
        visualping,
        "preactionsActive",
      ],
      optional: true,
    },
    preactionsObjects: {
      propDefinition: [
        visualping,
        "preactionsObjects",
      ],
      optional: true,
    },
    advancedScheduleActive: {
      propDefinition: [
        visualping,
        "advancedScheduleActive",
      ],
      optional: true,
      reloadProps: true,
    },
    multicheckEnabled: {
      propDefinition: [
        visualping,
        "multicheckEnabled",
      ],
      optional: true,
    },
    enableSmsAlert: {
      propDefinition: [
        visualping,
        "enableSmsAlert",
      ],
      default: false,
    },
    enableEmailAlert: {
      propDefinition: [
        visualping,
        "enableEmailAlert",
      ],
      default: false,
    },
    useSlackNotification: {
      propDefinition: [
        visualping,
        "useSlackNotification",
      ],
      default: false,
      reloadProps: true,
    },
    useTeamsNotification: {
      propDefinition: [
        visualping,
        "useTeamsNotification",
      ],
      default: false,
      reloadProps: true,
    },
    useWebhookNotification: {
      propDefinition: [
        visualping,
        "useWebhookNotification",
      ],
      default: false,
      reloadProps: true,
    },
    useDiscordNotification: {
      propDefinition: [
        visualping,
        "useDiscordNotification",
      ],
      default: false,
      reloadProps: true,
    },
    useSlackAppNotification: {
      propDefinition: [
        visualping,
        "useSlackAppNotification",
      ],
      default: false,
      reloadProps: true,
    },
    workspaceId: {
      propDefinition: [
        visualping,
        "workspaceId",
      ],
    },
  },
  async additionalProps() {
    const props = {};
    if (this.targetDevice && (this.targetDevice === "1" || this.targetDevice === "3")) {
      props.cropX = {
        type: "integer",
        label: "Crop X",
        description: "Start X position to the crop.",
      };
      props.cropY = {
        type: "integer",
        label: "Crop Y",
        description: "Start Y position to the crop.",
      };
      props.cropWidth = {
        type: "integer",
        label: "Crop Width",
        description: "The width of the crop.",
      };
      props.cropHeight = {
        type: "integer",
        label: "Crop Height",
        description: "The height of the crop.",
      };
    }
    if (this.mode && this.mode === "TEXT") {
      props.keywordAction = {
        type: "string",
        label: "Keyword Action",
        description: "Keyword detection mode.",
        optional: true,
        options: [
          "ADDED",
          "ALL",
          "DELETED",
        ],
      };
      props.keywords = {
        type: "string[]",
        label: "Keywords",
        description: "List of keywords.",
        optional: true,
      };
    }
    if (this.advancedScheduleActive) {
      props.stopTime = {
        type: "integer",
        min: 0,
        max: 24,
        label: "Stop Time",
        description: "The time to stop.",
      };
      props.startTime = {
        type: "integer",
        min: 0,
        max: 24,
        label: "Start Time",
        description: "The time to start.",
      };
      props.activeDays = {
        type: "integer[]",
        label: "Active days",
        description: "List of days from 1 to 7.",
      };
    }
    if (this.useSlackNotification) {
      props.slackUrl = {
        type: "string",
        label: "Slack URL",
        description: "The URL to the slack notification.",
      };
      props.slackChannels = {
        type: "string[]",
        label: "Slack Channels",
        description: "A list of slack's channels.",
      };
    }
    if (this.useTeamsNotification) {
      props.teamsUrl = {
        type: "string",
        label: "Teams URL",
        description: "The URL to the teams notification.",
      };
    }
    if (this.useWebhookNotification) {
      props.webhookUrl = {
        type: "string",
        label: "Webhook URL",
        description: "The URL to the webhook notification.",
      };
    }
    if (this.useDiscordNotification) {
      props.discordUrl = {
        type: "string",
        label: "Discord URL",
        description: "The URL to the discord notification.",
      };
    }
    if (this.useSlackAppNotification) {
      props.slackAppUrl = {
        type: "string",
        label: "Slack App URL",
        description: "The URL to the slack app notification.",
      };
      props.slackAppChannels = {
        type: "string[]",
        label: "Slack App Channels",
        description: "A list of slack app' channels.",
      };
    }
    return props;
  },
  async run({ $ }) {
    const {
      visualping,
      adCampaign,
      targetDevice,
      fixedProxyAlias,
      disableJS,
      pageHeight,
      waitTime,
      preactionsActive,
      preactionsObjects,
      advancedScheduleActive,
      multicheckEnabled,
      enableSmsAlert,
      enableEmailAlert,
      useSlackNotification,
      useTeamsNotification,
      useWebhookNotification,
      useDiscordNotification,
      useSlackAppNotification,
      workspaceId,
      cropX,
      cropY,
      cropWidth,
      cropHeight,
      keywordAction,
      keywords,
      mode,
      trigger,
      stopTime,
      startTime,
      activeDays,
      slackUrl,
      slackChannels,
      teamsUrl,
      webhookUrl,
      discordUrl,
      slackAppUrl,
      slackAppChannels,
      ...data
    } = this;

    const advancedSchedule = advancedScheduleActive
      ? {
        stop_time: stopTime,
        start_time: startTime,
        active_days: activeDays,
      }
      : null;

    const nofiticationConfig = {};
    if (useSlackNotification) {
      nofiticationConfig.slack = {
        url: slackUrl,
        active: true,
        channels: slackChannels,
      };
    }
    if (useTeamsNotification) {
      nofiticationConfig.teams = {
        url: teamsUrl,
        active: true,
      };
    }
    if (useWebhookNotification) {
      nofiticationConfig.webhook = {
        url: webhookUrl,
        active: true,
      };
    }
    if (useDiscordNotification) {
      nofiticationConfig.discord = {
        url: discordUrl,
        active: true,
      };
    }
    if (useSlackAppNotification) {
      nofiticationConfig.slack_app = {
        url: slackAppUrl,
        active: true,
        channels: slackAppChannels,
      };
    }

    const crop = (this.targetDevice && (this.targetDevice === "1" || this.targetDevice === "3")) ?
      {
        x: cropX,
        y: cropY,
        width: cropWidth,
        height: cropHeight,
      }
      : null;

    const response = await visualping.createJob({
      $,
      data: {
        ...data,
        ad_campaign: adCampaign,
        target_device: targetDevice,
        fixed_proxy_alias: fixedProxyAlias,
        disable_js: disableJS,
        page_height: pageHeight,
        wait_time: waitTime,
        preactions: {
          active: preactionsActive,
          actions: preactionsObjects,
        },
        trigger,
        advanced_schedule: advancedSchedule,
        mode,
        multicheck_enabled: multicheckEnabled,
        notification: {
          enableSmsAlert,
          enableEmailAlert,
          configuration: {
            ...nofiticationConfig,
          },
          threshold: {
            VISUAL: parseFloat(trigger),
            TEXT: parseFloat(trigger),
            WEB: parseFloat(trigger),
          },
        },
        workspaceId,
        crop,
        keyword_action: keywordAction,
        keywords: keywords && keywords.toString(),
      },
    });

    $.export("$summary", `A new job with id ${response.id} was successfully created!`);
    return response;
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
VisualPingvisualpingappThis component uses the VisualPing app.
Emailemailstring

An email for internal use.

Businessbusinessboolean

For internal use.

Localelocalestring

Locale for internal use.

Site ReferersiteRefererstring

Site Referer for internal use.

Ad CampaignadCampaignobject

For internal use.

Originoriginstring

For internal use.

Content TypecontentTypestring

For internal use.

URLurlstring

Url of the web page monitored by this job.

Descriptiondescriptionstring

Job Description

ModemodestringSelect a value from the drop down menu:TEXTVISUALWEB
Activeactiveboolean

Whether the job is active or paused.

Intervalintervalstring

Job's crawling interval expressed in minutes. Examples: 5, 15, 1440...

Triggertriggerstring

Job's diff detection trigger expressed in percents. Examples: 0.1, 25...

Target DevicetargetDevicestringSelect a value from the drop down menu:{ "label": "1 - Area", "value": "1" }{ "label": "2 - Mobile", "value": "2" }{ "label": "3 - Specific Fold", "value": "3" }{ "label": "4 - All Page", "value": "4" }
Proxyproxystring

String code representing the optional proxy to use for this job. Contact Visualping for details.

Fixed Proxy AliasfixedProxyAliasstring

For internal use.

Xpathxpathstring

Optional xpath representing the root web element to consider for this job.

Rendererrendererstring

For internal use.

Disable JSdisableJSboolean

For internal use.

Page HeightpageHeightstring

For internal use.

Wait TimewaitTimeinteger

Number of seconds to wait the crawling and before applying any actions on the wab page.

Preactions ActivepreactionsActiveboolean

Whether Preactions is active or not.

Preactions ObjectspreactionsObjectsany

Array of LegacyJobPreAction objects.

Advanced Schedule ActiveadvancedScheduleActiveboolean

Whether advanced schedule is active or not.

Multicheck EnabledmulticheckEnabledstring

For internal use.

Enable SMS AlertenableSmsAlertboolean

Used to enable sms notifications for the considered job. Typically false.

Enable Email AlertenableEmailAlertboolean

Used to enable email notifications for the considered job. Typically false.

Use Slack NotificationuseSlackNotificationboolean

If this job uses slack notification.

Use Teams NotificationuseTeamsNotificationboolean

If this job uses teams notification.

Use Webhook NotificationuseWebhookNotificationboolean

If this job uses webhook notification.

Use Discord NotificationuseDiscordNotificationboolean

If this job uses discord notification.

Use Slack App NotificationuseSlackAppNotificationboolean

If this job uses slack app notification.

Workspace IDworkspaceIdstringSelect a value from the drop down menu.

Authentication

VisualPing uses OAuth authentication. When you connect your VisualPing account, Pipedream will open a popup window where you can sign into VisualPing and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any VisualPing API.

Pipedream requests the following authorization scopes when you connect your account:

About VisualPing

Website change detection, monitoring and alerting

More Ways to Use VisualPing

Triggers

New Alert Received from the VisualPing API

Emit new event when a change alert is sent.

 
Try it
New Job Created from the VisualPing API

Emit new event for each new job created.

 
Try it
New Job Event from the VisualPing API

Emit new event for each new job event.

 
Try it

Actions

Delete Job with the VisualPing API

Delete an existing job by id. See the docs here

 
Try it
Find Jobs with the VisualPing API

Find existing jobs using filters. See the docs here

 
Try it
Get Job Details By Id with the VisualPing API

Get an existing job by id. See the docs here

 
Try it
Update Job with the VisualPing API

Update an existing job. See the docs here

 
Try it

Explore Other Apps

1
-
24
of
2,400+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.