Webhooks API
Programmatic management of webhook endpoints. Concepts and signature verification live in the webhooks guide.
POST /v1/webhooks
curl -X POST "https://api.scrapersocial.com/v1/webhooks" \ -H "Authorization: Bearer sk_live_..." \ -H "Content-Type: application/json" \ -d '{"url": "https://example.com/hooks/ss", "events": ["job.completed"]}'{ "data": { "webhook_id": "wh_01JZ...", "url": "https://example.com/hooks/ss", "events": ["job.completed"], "secret": "whsec_..." }, "request_id": "req_01JZX4M8Q2TE9W"}secret is returned once — store it for signature verification.
| Field | Type | Notes |
|---|---|---|
url | string, required | HTTPS only |
events | string[], required | Any of job.completed, credits.low, plan.changed |
GET /v1/webhooks
Lists registered endpoints (secrets are never returned again).
DELETE /v1/webhooks/{webhook_id}
Removes the endpoint; in-flight deliveries finish, no new ones are queued. Returns
204 No Content.
Related: Webhooks guide · Verify-webhook recipe