Webhooks

Webhooks tell Scrapest where to send data when a tracked source publishes new content. Instead of polling the API, your server receives a push the moment an event occurs. Each API key supports one webhook URL. If you need separate delivery endpoints for different projects, use separate API keys.

​

The Table

The Webhooks page lists all registered webhooks with the following columns:

• Name — the label you gave the webhook
• URL — your endpoint, truncated; hover to see the full value
• Status — the current health of the webhook:
  • ACTIVE — deliveries are succeeding
  • FAILED — the last delivery attempt failed (your endpoint returned a non-2xx status or timed out)
  • DISABLED — the webhook has been manually paused
• API Key — the key this webhook is registered under

​

Actions

​

Create a Webhook

1. Click “New Webhook” in the top-right corner.
2. Select the API key to associate this webhook with.
3. Enter a name and your endpoint URL.
4. Click Create.

Scrapest will begin delivering events to that URL for every source tracked under the selected API key.

​

Edit a Webhook

1. Click the ⋯ menu on the webhook row.
2. Select Edit.
3. Update the name or URL and save.

Changing the URL takes effect immediately — the next delivery will go to the new endpoint.

​

Test a Webhook

1. Click the ⋯ menu on the webhook row.
2. Select Test.

This fires a test payload to your endpoint so you can verify it’s reachable and responding correctly — useful before you start tracking live sources.

​

Delete a Webhook

1. Click the ⋯ menu on the webhook row.
2. Select Delete and confirm.

Deleting a webhook stops all future deliveries. Your tracked sources continue running — they just won’t deliver events until a new webhook is registered under the same key.

​

Payload Format

Webhook payloads follow the SourceEvent schema used across the entire Scrapest platform. See the WebSocket documentation for the full payload structure and example payloads for Twitter and Discord.