All integrations

Webhooks integration

Know the moment a capture finishes or a page changes

Webhooks post a signed JSON event to your endpoint as things happen: a capture succeeded or failed, a scheduled page changed, a delivery to your storage completed, a schedule was paused or a sitemap run ended. No polling.

Every paid plan

At a glance

Plans
Included in every paid plan
Products
Auto Schedule and Instant Snap API
Signature
HMAC-SHA256 in the X-WSW-Signature header
Retries
Six attempts over about 9 hours
Endpoint
Any public https address

Events worth reacting to

Captures that succeed or fail

capture.succeeded and capture.failed, from scheduled pages and from Instant Snap API requests, with the capture's details.

Pages that change

capture.changed when a scheduled capture differs from the one before it, with the change percentage and the capture it was compared to.

Deliveries and runs

delivery.completed when a capture reached your cloud storage, schedule.paused when we had to pause a schedule, sitemap_run.completed when every page of a run is done.

Signed, so you can trust them

Every delivery carries a timestamped HMAC-SHA256 signature. Each client library and the n8n trigger check it for you.

Retried until they land

Any 2xx within 10 seconds is success. Otherwise we try again after about 1 minute, 5 minutes, 30 minutes, 2 hours and 6 hours.

A delivery log

Every attempt of the last 30 days with its status code and timing, a Send again button, and a Send test button that posts a ping.

Set up an endpoint

  1. 1

    Add the endpoint

    In the app, open Developer Tools, then Webhooks, and choose Add endpoint. Enter its https address and tick the events it should receive.

  2. 2

    Narrow it if you like

    Limit the endpoint to one product, Auto Schedule or Instant Snap, or to a single schedule.

  3. 3

    Switch it on for schedules

    For Auto Schedule events, turn on Trigger webhook under After the capture in the Web Profile the schedule uses.

  4. 4

    Verify and answer fast

    Check the signature with the workspace's signing secret, answer 2xx at once and do the work afterwards. Press Send test to see a ping arrive.

Where webhooks fit

Alert the team about a change

capture.changed goes to a small function that posts the page, the change percentage and a link to Slack or Teams.

Start an n8n workflow

The Website Screenshot World Trigger node receives the events, checks the signature, and runs the workflow for the ones you picked.

Process captures without polling

Send an Instant Snap API request with callback_url and carry on; the result arrives as soon as the capture is done.

Keep your records complete

delivery.completed and sitemap_run.completed tell your archive or reporting job that a set of files is ready to read.

FAQ

Questions about Webhooks

Which plans include webhooks?

Every paid plan. Endpoints, events and the signing secret are managed under Developer Tools, Webhooks in the app.

Can the same event arrive twice?

Yes, occasionally, for example when your endpoint answered after we had already given up waiting. The event's id stays the same across attempts, so use it to skip repeats.

What happens if my endpoint is down?

Each delivery is tried six times over about nine hours and then marked Failed in the log, where you can send it again. After twenty consecutive failed deliveries the endpoint is switched off and we email you.

Why did a scheduled page send nothing?

Auto Schedule events are sent only for schedules whose Web Profile has Trigger webhook switched on. An endpoint alone is not enough.