How do I use Webhooks?

• What is a webhook?

• How to set up a webhook

• Webhook variables

• Webhook payload example

• FAQ

Webhooks are a high-performance alternative to email alerts, designed for users who need to process change notifications with structured data. When Visualping detects a change, it "pushes" a JSON payload directly to your endpoint, allowing you to instantly trigger workflows in platforms like Zapier, n8n, Slack, or custom internal tools.

The payload provides everything you need to automate your response:

• Direct Links: Access to screenshots, HTML snapshots, and processed PDF files.

• Context: Timestamps, job descriptions, and labels.

• Structured Data: AI-generated summaries, important alert flag and custom data extraction for specific fields.

Step 1:

Obtain a webhook URL from the platform you intend on using Visualping with. Some commonly used apps are:

• Webhooks by Zapier

• n8n Webhook node

• Microsoft Power Automate

• Make Webhooks

• Integrately Webhook

• Workato Webhooks connector

Step 2:

Open the Notifications tab in the job settings and click on Webhook.

Step 3:

Paste the Webhook URL into the URL field. If the URL is not valid, an inline warning will appear and the Test button will remain disabled until a valid URL is entered. Once a valid URL is detected, click Test to push a test JSON payload to the third-party app and confirm the connection.

• Green check mark - Success

• Red X mark - Fail

Pro Tip: To scale your automation, use bulk edit to apply a single webhook URL to multiple jobs simultaneously. You can also save your URL as a preset and set it as the workspace default to automatically configure webhooks for every new job you create.

All standard variables are included in every alert. However, conditional fields are omitted from the payload entirely if they are not active for that specific job.

Below is an example of the JSON payload sent to your webhook endpoint.

{

  "job_id": 12344567,
  "workspace_id": 12345,
  "workspace_name": "my workspace",
  "url": "https://www.visualping.io/",
  "description": "Example job name",
  "datetime": "Thu Apr 24 2025 17:10:41 GMT+0000 (Coordinated Universal Time)",
  "original": "https://vp-public-assets.s3.us-west-2.amazonaws.com/emails/onboarding-emails/text-change-alerts.png",
  "current": "https://vp-public-assets.s3.us-west-2.amazonaws.com/emails/onboarding-emails/text-change-alerts.png",
  "preview": "https://vp-public-assets.s3.us-west-2.amazonaws.com/emails/onboarding-emails/text-change-alerts.png",
  "html_previous": "https://vp-public-assets.s3.us-west-2.amazonaws.com/emails/onboarding-emails/text-change-alerts.html",
  "html_current": "https://vp-public-assets.s3.us-west-2.amazonaws.com/emails/onboarding-emails/text-change-alerts.html",
  "change": "10 %",
  "view_changes": "https://visualping.io/autologin?redirect=%2Fjobs%2F5922158%3Fmode%3Dtext",
  "job_settings": "https://visualping.io/autologin?redirect=%2Fjobs%2F5922158%3Fmode%3Dtext",
  "visual_changes": "https://visualping.io/diff/123456789?disableId=1234567890abcde&mode=visual",
  "text_changes": "https://visualping.io/diff/123456789?disableId=1234567890abcde&mode=text",
  "added_text": "Added text",
  "removed_text": "Removed text",
  "advancedfiletype_original_previous": "https://vp-public-assets.s3.us-west-2.amazonaws.com/emails/onboarding-emails/text-change-alerts.pdf", // Omitted if the job is not monitoring a PDF.
  "advancedfiletype_original_current": "https://vp-public-assets.s3.us-west-2.amazonaws.com/emails/onboarding-emails/text-change-alerts.pdf", // Omitted if the job is not monitoring a PDF.
  "labels": "⚽ label1, 🎁 label2",
  "summarizer": "Example change summary",
  "important": "false", // Requires text input in "Alert me when:" or "Any important changes" to return "true" or "false", otherwise "no analyzer call".
  "good_feedback": "https://visualping.io/feedback?id=0&jobId=0&vote=GOOD&processId=0&source=Webhook",
  "bad_feedback": "https://visualping.io/feedback?id=0&jobId=0&vote=BAD&processId=0&source=Webhook",
  "extracted_data": { 
    "product_price": "$99.99",
    "stock_status": "In Stock",
    "last_updated": "2024-05-01"
  }, // Omitted if custom data extraction is not enabled
}

Note: The extracted_data object supports flexible structures, including nested keys and arrays, depending on your specific data requirements. Contact us for more details.

To keep the data payload clean and efficient, Visualping omits certain fields entirely if they aren't applicable to the specific job. For example, PDF download links only appear if you are monitoring a PDF file, and the labels key is only included if you have assigned labels to that job. If a field is missing, it simply means there was no data to report for that specific attribute.

You can use the extracted_data variable to send specific data points from a webpage directly to your endpoint. This feature allows for structured JSON output of specific fields (supporting nested keys and arrays). This is a premium feature available on our Solutions plan. If you need custom data extraction, please contact our support team to have it configured for your jobs.

• Notifications overview

• n8n integration