ScreenshotCoreScreenshotCore
POST/api/v1/screenshot

Async & Webhooks

Queue a capture job and receive the result via webhook. Ideal for long-running captures or high-volume workloads.

Add async=true and a webhook_url to any POST request. The API returns 202 Accepted immediately. When the capture finishes, ScreenshotAPI POSTs the result to your webhook_url.

Webhook delivery

Your endpoint must respond with a 2xx status within 10 seconds. If webhook_sign=true, the request includes an X-Webhook-Signature header (HMAC-SHA256 of the body using your API key's signing secret).

Parameters

NameTypeRequiredDescription
asyncbooleanrequiredSet to true to queue the job and return 202 immediately.
webhook_urlstringrequiredHTTPS URL that will receive a POST with the capture result.
webhook_signbooleanoptionalSign the webhook payload with HMAC-SHA256 (X-Webhook-Signature header).

Code Examples

curl -X POST "https://screenshotcore.com/api/v1/screenshot" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url":          "https://example.com",
    "format":       "png",
    "full_page":    true,
    "async":        true,
    "webhook_url":  "https://yourapp.com/webhooks/screenshot",
    "webhook_sign": true
  }'

Response

{
  "message": "Screenshot queued for processing.",
  "webhook_url": "https://yourapp.com/webhooks/screenshot"
}
Metadata ExtractionSigned Requests