Feature · API & Automation

A visual regression API built for agency automation.

Put visual checks into your deploy scripts, CI/CD, custom dashboards and ticketing tools. Start checks through a stable REST API, get signed webhooks the moment something changes, and set up new clients as subaccounts without opening the dashboard.

webchangedetector.com / webhooks
Webhooks for Batch Completed and New Change Detected events
What you get

Wire visual QA into your stack.

REST API v2

Clean REST endpoints for websites, URLs, checks, comparison results, subaccounts, and usage forecasting with Bearer token authentication.

Additive-only contract

Fields are only ever added, never renamed or removed. Your deploy scripts keep working after every release.

Webhooks

Get an event when a new change is found, when a check run completes, and when a single check completes or fails. Failed deliveries are retried automatically.

Run monitoring now

One API call at the end of your deploy script checks every monitored page right away. Ideal when a host pushes staging to live as a copy and no page is saved.

Zapier built in

Send changes to Slack, ClickUp, Asana or Google Sheets via Zapier, without code. The Zapier builder sits right in your dashboard.

A number to automate on

Every comparison comes with its change percentage, the AI verdict per change and the before and after link, plus new JavaScript errors on Team plans and above. The one-sentence summary comes with each check run. Build your own release gate on it.

Zapier integration with popular workflows for Telegram, Slack and Asana
Zapier

No code, any app on Zapier.

Turn changes into team workflows via Zapier: post to the Slack channel of a client’s maintenance team, open a ClickUp task with the comparison link, or keep a log of every change in Google Sheets.

  • A new-change trigger in Zapier.
  • Build the Zap inside your dashboard, no switching tabs.
  • Combine with filters to alert only on specific sites.
  • Runs alongside webhooks; use either or both.
Explore the Zapier integration →
How it works

How the website monitoring API works.

Everything the dashboard does, your scripts can do too: the automation loop in six steps.

STEP 01

Get your token

Generate API tokens for your root agency account or individual subaccounts. Authorize requests with standard Authorization: Bearer headers.

STEP 02

Register sites and URLs

Add client websites and URLs and switch desktop and mobile on or off, through the API or in the dashboard. Both always show the same setup.

STEP 03

Trigger checks

Start an On-Demand Check with one POST: before screenshots ahead of your change, after screenshots once it is live. Or run Monitoring now on every monitored page.

STEP 04

Get results your way

No polling needed: webhooks deliver the result the moment a check run finishes or a new change is found. Or read it from the API whenever you like.

STEP 05

Automate on the numbers

Fail a deploy when the change percentage on a key page passes your limit, or page someone when a page goes blank. A page that turns blank always triggers an alert.

STEP 06

Build without breaking

Build on an API that only ever adds fields. What you automate today keeps working after the next release.

Show me the calls

Two requests to your first automated check.

Run monitoring now for a whole group, for example as the last step of a deploy script:

curl -X POST https://api.webchangedetector.com/api/v2/monitoring/trigger \
  -H "Authorization: Bearer $WCD_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "group_id": "023c282c-6513-420a-a36b-a654312ab229",
    "type": "manual_trigger",
    "scope": "all"
  }'

Then read the result, or receive it as a webhook instead of polling:

curl https://api.webchangedetector.com/api/v2/batches/$BATCH_ID \
  -H "Authorization: Bearer $WCD_TOKEN"

In CI/CD, the same API becomes a visual release gate: take before screenshots ahead of the deploy, after screenshots once it is live, and fail the build when the change percentage passes your limit. Detailed endpoint specifications and code samples are available on the REST API integration page.

On limits: requests are rate-limited per minute and account, and the screenshots of a large check run are queued and worked through in order. If your workload needs more, talk to us.

In practice

Three automations built on the API.

The deploy gate

Every production deploy checks ten template pages. If a change percentage passes 5%, the build fails and the comparison link lands in the pull request.

The change log

Webhook events flow into your own database: every change on every client site, with date, time and comparison link. Finding out what changed when becomes a query, not a project.

The provisioning hook

When your billing system signs a new customer, an API call creates their subaccount, website, and URLs. Onboarding becomes one script, not an afternoon.

Why not by hand?

Post-deploy QA by hand vs. automated.

The manual version

Manual post-deploy spot checks rely on memory and available time. Friday evening hotfixes receive the least scrutiny of all. A subtle CSS corruption or broken mobile menu goes live unnoticed until client support tickets arrive.

The automated version

Automated visual checks run on every pull request and release and compare against the pre-deploy screenshots, desktop and mobile. If something breaks or new console errors appear, your pipeline can stop the deploy. Nobody has to remember to look.

FAQ

Frequently asked questions

Can I trigger visual regression checks from GitHub Actions or GitLab CI?

Yes. Start an On-Demand Check or run Monitoring now with one REST request from your CI job, receive the result as a webhook or read it from the API, and fail the build when the change percentage passes your limit.

How do I verify the authenticity of incoming WebChange Detector webhooks?

Every delivery carries a signature in its Signature header, created with your account’s webhook secret. The Webhooks page shows the check with a code sample.

Is the REST API available on all agency subscription plans?

Every account has an API token, the same one the plugin for WordPress uses. Your plan sets how many checks you can run.

How does API authentication work?

Authentication uses Bearer tokens in the Authorization header. Your main account and every subaccount have their own API token, so a script can be limited to one client.

What are the API rate limits?

Requests are rate-limited per minute and account. The screenshots of a check run are queued and worked through in order, so you start even a large run with one call. If you need higher limits, talk to us.

Can we automate client provisioning through the API?

Yes. You can programmatically create subaccounts, set check limits, add domains and URLs, and configure alert recipients as part of your agency’s automated client onboarding workflow.

Does the API return JavaScript console error logs alongside visual diffs?

Yes. Each comparison includes the change percentage, the AI verdict per change and the link to the before and after view, plus the JavaScript console errors that were added or removed on Team plans and above. The one-sentence summary comes with each check run.

Catch the next visual bug before anyone else.

Start with a free trial, connect a site, and see your first before and after comparison today.