Hyperscrape
Docs

Guides

Webhooks

Get notified when runs succeed or fail.

Overview

Webhooks let Hyperscrape call your server when a run finishes. Use them to trigger downstream processing the moment fresh data is available.

Setting up

  1. Go to Console → Settings → Webhooks → Add webhook.
  2. Enter the URL to call.
  3. Choose which events to subscribe to (RUN.SUCCEEDED, RUN.FAILED).
  4. Optionally scope the webhook to a single scraper.

Payload

Hyperscrape sends a POST request with a JSON body:

{
  "event": "RUN.SUCCEEDED",
  "runId": "9f8c...",
  "scraper": "price-monitor",
  "createdAt": "2026-01-01T12:00:00.000Z"
}

If you set a secret on the webhook, it's sent in the X-Hyperscrape-Secret header so you can verify the request came from us.

Handling delivery

Fetch the run and its dataset using the IDs in the payload to process the results. Your endpoint should respond quickly with a 2xx status; do heavy processing asynchronously.

← SchedulingDatasets & Storage →