# Batch Scrape Started (/api-reference/endpoint/webhook-batch-scrape-started)

<!-- agent-signals: reading_time_min: 1 · est_tokens: 629 · updated: 2026-07-30 -->
Related: [Search](/api-reference/endpoint/search.md), [Search Feedback](/api-reference/endpoint/search-feedback.md), [Scrape](/api-reference/endpoint/scrape.md), [Batch Scrape](/api-reference/endpoint/batch-scrape.md), [Get Batch Scrape Status](/api-reference/endpoint/batch-scrape-get.md), [Cancel Batch Scrape](/api-reference/endpoint/batch-scrape-delete.md)

For payload examples, configuration, and retry behavior, see [Webhook Event Types](/webhooks/events#batch_scrapestarted) and [Webhook Overview](/webhooks/overview).

`POST` webhook `batchScrapeStarted`

Batch Scrape Started

## OpenAPI

```json
{
  "parameters": [
    {
      "name": "X-Firecrawl-Signature",
      "in": "header",
      "required": false,
      "description": "HMAC-SHA256 signature of the raw request body, formatted as `sha256=<hex>`. Present when an HMAC secret is configured in your [account settings](https://www.firecrawl.dev/app/settings?tab=advanced). See [Webhook Security](/webhooks/security) for verification details.",
      "schema": {
        "type": "string",
        "example": "sha256=abc123def456789..."
      }
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "success",
            "type",
            "id",
            "webhookId",
            "data"
          ],
          "properties": {
            "success": {
              "type": "boolean",
              "const": true
            },
            "type": {
              "type": "string",
              "const": "batch_scrape.started"
            },
            "id": {
              "type": "string",
              "format": "uuid",
              "description": "The batch scrape job ID, matching the `id` returned by `POST /batch/scrape`."
            },
            "webhookId": {
              "type": "string",
              "format": "uuid",
              "description": "Unique identifier for this webhook delivery."
            },
            "data": {
              "type": "array",
              "items": {},
              "default": []
            },
            "metadata": {
              "type": "object",
              "description": "The custom metadata object you provided in the webhook configuration. Echoed back in every delivery.",
              "additionalProperties": {
                "type": "string"
              }
            }
          }
        },
        "example": {
          "success": true,
          "type": "batch_scrape.started",
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "webhookId": "b2c3d4e5-0001-0000-0000-000000000000",
          "data": [],
          "metadata": {}
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Return any `2xx` status code to acknowledge receipt."
    }
  }
}
```
