Skip to main content
WEBHOOK
batchScrapePage
{
  "success": true,
  "type": "batch_scrape.page",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "webhookId": "b2c3d4e5-0002-0000-0000-000000000000",
  "data": [
    {
      "markdown": "# Example Page\n\nThis is the page content.",
      "metadata": {
        "title": "Example Page",
        "description": "An example page.",
        "sourceURL": "https://example.com",
        "statusCode": 200
      }
    }
  ],
  "metadata": {}
}

Headers

X-Firecrawl-Signature
string

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.

Example:

"sha256=abc123def456789..."

Body

application/json
success
boolean
required

true if the page was scraped successfully, false otherwise.

type
string
required
Allowed value: "batch_scrape.page"
id
string<uuid>
required

The batch scrape job ID.

webhookId
string<uuid>
required

Unique identifier for this webhook delivery.

data
object[]
required

Array containing the scraped page document.

error
string

Error message if the page failed to scrape.

metadata
object

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

Response

200

Return any 2xx status code to acknowledge receipt.