Skip to main content
WEBHOOK

Headers

x-screenshotapi-signature
string
required

Signature: t=UNIX_SECONDS,v1=HEX_DIGEST.

x-screenshotapi-job-id
string
required

Capture job ID.

x-screenshotapi-event
enum<string>
required

Terminal capture event.

Available options:
capture.completed,
capture.failed
x-screenshotapi-delivery-id
string
required

Stable delivery ID.

x-screenshotapi-generation
string
required

Delivery generation.

x-screenshotapi-delivery
string
required

Attempt number.

Body

application/json
event
enum<string>
required
Available options:
capture.completed,
capture.failed
id
string
required
job_id
string
required
request_id
string
required
mode
enum<string>
required
Available options:
sync,
async
ok
boolean
required
data
object | null
required
error
object | null
required
duration_ms
number
required
attempts_made
integer
required
enqueued_at
integer
required
completed_at
integer
required
delivery_id
string
required
delivery_generation
integer
required

Response

200

Return a 2xx status after safely accepting the event.