Crawl Started

Webhook event sent when a crawl job begins processing.

1 min read

webhookcrawlStarted

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#

Always true for this event.

Options:true

typeenum<string>required#

The event type.

Options:crawl.started

idstringrequired#

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

webhookIdstringrequired#

Unique identifier for this webhook delivery. Use for deduplication — the same value is sent on retries.

dataany[]required#

Empty array for this event.

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.

Update Threat Protection Policy Crawl Page