Webhooks
Create Webhook
Register a new webhook endpoint for real-time event delivery
POST
Register a new webhook endpoint to receive real-time events when tracked sources post new content.
Request
string
required
The HTTPS endpoint URL where events will be delivered.
string
Optional name for the webhook for easy identification.
Response
object
The created webhook object
string
Status message describing the result
Delivery & Failure Handling
Each event is delivered as an HTTPPOST with a JSON body and a 5-second timeout. Scrapest retries transient failures with exponential backoff, but to protect your endpoint and our delivery pipeline it will automatically pause a webhook that keeps failing.
The status field reflects this:
A webhook is moved to
FAILED when either:
- Your endpoint returns 404 or 410 (gone) on a delivery — paused immediately, since the URL is treated as permanently removed, or
- It accumulates 5 consecutive delivery failures within a 24-hour window (timeouts, 5xx, connection errors, etc.).
To resume a paused webhook, re-register it (
POST /webhook) or update
it (PATCH /webhook) — both reset
status back to ACTIVE and restart delivery. Make sure your endpoint
responds with a 2xx status and within 5 seconds to stay active.