Batch Scrape Started

Webhook event sent when a batch scrape job begins processing.

WEBHOOK batchScrapeStarted

Example

{
  "success": true,
  "type": "batch_scrape.started",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "webhookId": "b2c3d4e5-0001-0000-0000-000000000000",
  "data": [],
  "metadata": {}
}

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

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

type · string · required

Allowed value: "batch_scrape.started"

id · string<uuid> · required

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

webhookId · string<uuid> · required

Unique identifier for this webhook delivery.

data · any[] · required

metadata · object

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

Show child attributes

Response

200

Return any 2xx status code to acknowledge receipt.