Skip to main content
WEBHOOK
Para exemplos de payload, configuração e comportamento de novas tentativas, consulte Tipos de eventos de Webhook e Visão geral do Webhook.

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.

id
string<uuid>
obrigatório

O ID do job de extração em lote.

success
boolean
obrigatório

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

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

Identificador único desta entrega de webhook.

error
string

Mensagem de erro caso a extração da página falhe.

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.