Pular para o conteúdo principal
Webhooks permitem que você receba notificações em tempo real sobre suas operações à medida que progridem, em vez de consultar periodicamente por atualizações de status.

​
Operações compatíveis

OperaçãoEventos
Crawlstarted, page, completed
Batch Scrapestarted, page, completed
Extractstarted, completed, failed

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

​
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:
TentativaAtraso 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.