Skip to main content
WEBHOOK
payloadの例、設定、再試行の動作については、webhookイベントタイプwebhookの概要 を参照してください。

ヘッダー

X-Firecrawl-Signature
string

生のリクエスト本文の HMAC-SHA256 署名。形式は sha256=<hex> です。アカウント設定で HMAC シークレットが設定されている場合に含まれます。検証の詳細は Webhook Security を参照してください。

:

"sha256=abc123def456789..."

ボディ

application/json
data
object[]
必須

スクレイピングされたページのドキュメントを含む配列。GET /scrapeレスポンスのdataフィールドと同じ構造です。

id
string<uuid>
必須

クロールジョブID。

success
boolean
必須

ページのスクレイピングが成功した場合はtrue、それ以外の場合はfalse

type
string
必須

イベントタイプ。

Allowed value: "crawl.page"
webhookId
string<uuid>
必須

このWebhook配信の一意の識別子。

error
string

ページのスクレイピングに失敗した場合のエラーメッセージ。

metadata
object

webhook 設定で指定したカスタムメタデータオブジェクト。すべての配信でそのまま返されます。

レスポンス

200

受信を確認するには、任意の 2xx ステータスコードを返してください。