Skip to main content
Firecrawl Docs

Batch Scrape Page

Webhook event sent for each URL scraped during a batch scrape job.
1 min read
webhookbatchScrapePage
webhookbatchScrapePage

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
successbooleanrequired#
true if the page was scraped successfully, false otherwise.
typeenum<string>required#
Options:batch_scrape.page
idstringrequired#
The batch scrape job ID.
webhookIdstringrequired#
Unique identifier for this webhook delivery.
dataobject[]required#
Array containing the scraped page document.
Show child attributes
markdownstring#
The page content converted to Markdown.
htmlstring#
Cleaned HTML content of the page.
rawHtmlstring#
Original HTML before any processing.
linksstring[]#
Outbound links discovered on the page.
screenshotstring#
Base64-encoded screenshot, if the screenshot format was requested.
metadataobject#
Page metadata.
Show child attributes
titlestring#
The page <title>.
descriptionstring#
The meta description.
sourceURLstring#
The URL that was scraped.
statusCodeinteger#
HTTP status code of the response.
errorstring#
Error message if the page failed to scrape.
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.
Batch Scrape StartedBatch Scrape Completed