Pular para o conteúdo principal
WEBHOOK
Para ver exemplos de payload, configuração e comportamento de novas tentativas, consulte Webhook Event Types e Webhook Overview.

Cabeçalhos

X-Firecrawl-Signature
string

Assinatura HMAC-SHA256 do corpo bruto da requisição, formatada como sha256=<hex>. Presente quando um segredo HMAC estiver configurado nas configurações da sua conta. Consulte Segurança de Webhooks para detalhes sobre a verificação.

Exemplo:

"sha256=abc123def456789..."

Corpo

application/json
data
object[]
obrigatório

Array que contém o documento da página extraída. Tem o mesmo formato do campo data na resposta de GET /scrape.

id
string<uuid>
obrigatório

O ID do job de rastreamento.

success
boolean
obrigatório

true se a página tiver sido extraída com sucesso; caso contrário, false.

type
string
obrigatório

O tipo do evento.

Allowed value: "crawl.page"
webhookId
string<uuid>
obrigatório

Identificador único desta entrega de webhook.

error
string

Mensagem de erro se a extração da página falhar.

metadata
object

O objeto de metadados personalizado que você forneceu na configuração do webhook. Ele é retornado em todas as entregas.

Resposta

200

Retorne qualquer código de status 2xx para confirmar o recebimento.