Skip to main content
WEBHOOK
crawlStarted
{
  "success": true,
  "type": "crawl.started",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "webhookId": "a1b2c3d4-0001-0000-0000-000000000000",
  "data": [],
  "metadata": {}
}

Headers

​
X-Evocrawl-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

Always true for this event.

​
type
string
required

The event type.

Allowed value: "crawl.started"
​
id
string<uuid>
required

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

​
webhookId
string<uuid>
required

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

​
data
any[]
required

Empty array for this event.

​
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.