Real-time notifications for your Firecrawl operations
webhook
object to your request:
Field | Type | Required | Description |
---|---|---|---|
url | string | ✅ | Your webhook endpoint URL |
headers | object | ❌ | Custom headers to include in webhook requests |
metadata | object | ❌ | Custom data included in all webhook payloads |
events | array | ❌ | Event types to receive (default: all events) |
Event | Description | When Triggered |
---|---|---|
crawl.started | Crawl job initiated | When crawl begins |
crawl.page | Individual page scraped | After each page is successfully scraped |
crawl.completed | Crawl finished successfully | When all pages are processed |
crawl.failed | Crawl encountered an error | When crawl fails or is cancelled |
Event | Description | When Triggered |
---|---|---|
batch_scrape.started | Batch scrape job initiated | When batch scrape begins |
batch_scrape.page | Individual URL scraped | After each URL is successfully scraped |
batch_scrape.completed | Batch scrape finished | When all URLs are processed |
batch_scrape.failed | Batch scrape failed | When batch scrape fails or is cancelled |
Field | Type | Description |
---|---|---|
success | boolean | Whether the operation was successful |
type | string | Event type (e.g., crawl.page , batch_scrape.completed ) |
id | string | Unique identifier for the crawl/batch scrape job |
data | array | Scraped content (populated for page events) |
metadata | object | Custom metadata from your webhook configuration |
error | string | Error message (present when success is false ) |
timestamp | string | ISO 8601 timestamp of when the event occurred |
started
Eventspage
Eventscompleted
Eventsfailed
Events