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 ou um job de agente 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ções compatíveis

Operação	Eventos
rastreamento	started, page, completed
extração em lote	started, page, completed
extração	started, completed, failed
agente	started, action, completed, failed, cancelled

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

​

Configuração

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"]
  }
}

Campo	Tipo	Obrigatório	Descrição
url	string	Sim	URL do endpoint do seu webhook (HTTPS)
headers	object	Não	Cabeçalhos personalizados para incluir nas requisições do webhook
metadata	object	Não	Dados personalizados incluídos nas cargas do webhook
events	array	Não	Tipos de evento a receber (padrão: todos)

​

Uso

​

Rastreamento com webhook

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"]
      }
    }'

​

Raspagem em lote com webhook

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"]
      }
    }'

​

Timeouts e tentativas

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:

Tentativa	Atraso após falha
1ª	1 minuto
2ª	5 minutos
3ª	15 minutos

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