Skip to main content
POST
/
webhook
curl -X POST https://scrape.st/webhook \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-domain.com/webhook",
    "name": "My Webhook"
  }'
{
  "data": {
    "id": "wh_abc123",
    "apiKey": "sk_live_xxx",
    "name": "My Webhook",
    "url": "https://your-domain.com/webhook",
    "status": "ACTIVE"
  },
  "message": "Webhook registered successfully"
}
Register a new webhook endpoint to receive real-time events when tracked sources post new content.

Request

url
string
required
The HTTPS endpoint URL where events will be delivered.
name
string
Optional name for the webhook for easy identification.

Response

data
object
The created webhook object
message
string
Status message describing the result
curl -X POST https://scrape.st/webhook \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-domain.com/webhook",
    "name": "My Webhook"
  }'
{
  "data": {
    "id": "wh_abc123",
    "apiKey": "sk_live_xxx",
    "name": "My Webhook",
    "url": "https://your-domain.com/webhook",
    "status": "ACTIVE"
  },
  "message": "Webhook registered successfully"
}