Skip to content
Firecrawl Docs
Firecrawl Docs
Webhooks

Visão geral

Notificações em tempo real para suas operações no Firecrawl

Receba notificações assim que um rastreamento, uma extração em lote, uma extração, um job de agente ou uma verificação de monitor começar, avançar ou terminar. Em vez de consultar o status periodicamente, você fornece um endpoint HTTPS e o Firecrawl envia eventos para ele em tempo real.

OperaçãoEventos
rastreamentostarted, page, completed
extração em lotestarted, page, completed
extraçãostarted, completed, failed
agentestarted, action, completed, failed, cancelled
Monitorcheck.completed

Consulte Tipos de evento para ver os detalhes completos do payload e exemplos.

Adicione um objeto webhook à sua requisição:

JSON
{
  "webhook": {
    "url": "https://your-domain.com/webhook",
    "metadata": {
      "any_key": "any_value"
    },
    "events": ["iniciado", "página", "concluído", "fracassou"]
  }
}
CampoTipoObrigatórioDescrição
urlstringSimURL do endpoint do seu webhook (HTTPS)
headersobjectNãoCabeçalhos personalizados para incluir nas requisições do webhook
metadataobjectNãoDados personalizados incluídos nas cargas do webhook
eventsarrayNãoTipos de evento a receber (padrão: todos)
cURL
curl -X POST https://api.firecrawl.dev/v2/crawl \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer YOUR_API_KEY' \
    -d '{
      "url": "https://docs.firecrawl.dev",
      "limit": 100,
      "webhook": {
        "url": "https://your-domain.com/webhook",
        "metadata": {
          "any_key": "any_value"
        },
        "events": ["iniciado", "página", "concluído"]
      }
    }'
cURL
curl -X POST https://api.firecrawl.dev/v2/batch/scrape \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer YOUR_API_KEY' \
    -d '{
      "urls": [
        "https://example.com/page1",
        "https://example.com/page2",
        "https://example.com/page3"
      ],
      "webhook": {
        "url": "https://your-domain.com/webhook",
        "metadata": {
          "any_key": "any_value"
        },
        "events": ["started", "page", "completed"]
      }
    }'

Seu endpoint deve responder com um status 2xx em até 10 segundos.

Se a entrega falhar (timeout, status não 2xx ou erro de rede), o Firecrawl fará novas tentativas automaticamente:

TentativaAtraso após falha
1 minuto
5 minutos
15 minutos

Após 3 tentativas sem sucesso, o webhook é marcado como falho e nenhuma nova tentativa é feita.

Was this page helpful?Suggest editsRaise issue