Batch Scrape Started

Webhook event sent when a batch scrape job begins processing.

1 min read

webhookbatchScrapeStarted

For payload examples, configuration, and retry behavior, see Webhook Event Types and Webhook Overview.

Headers

X-Firecrawl-Signaturestring#

HMAC-SHA256 signature of the raw request body, formatted as sha256=<hex>. Present when an HMAC secret is configured in your account settings. See Webhook Security for verification details.

Body

application/json

successenum<boolean>required#

Options:true

typeenum<string>required#

Options:batch_scrape.started

idstringrequired#

The batch scrape job ID, matching the id returned by POST /batch/scrape.

webhookIdstringrequired#

Unique identifier for this webhook delivery.

dataany[]required#

Default: []

metadataobject#

The custom metadata object you provided in the webhook configuration. Echoed back in every delivery.

Show child attributes

{key}string#

Responses

200

Return any 2xx status code to acknowledge receipt.

Crawl Completed Batch Scrape Page