Descripción general - Firecrawl Docs

Recibe notificaciones en el momento en que un rastreo, una extracción por lotes, una extracción, un trabajo de agente o una comprobación de monitor comienza, avanza o finaliza. En lugar de consultar periódicamente el estado, proporcionas un endpoint HTTPS y Firecrawl te envía eventos en tiempo real.

Operaciones admitidas#

Operación	Eventos
Rastreo	`started`, `page`, `completed`
extracción por lotes	`started`, `page`, `completed`
Extract	`started`, `completed`, `failed`
Agent	`started`, `action`, `completed`, `failed`, `cancelled`
Monitor	`check.completed`

Consulta Tipos de eventos para obtener todos los detalles de la carga útil y ver ejemplos.

Configuración#

Añade un objeto webhook a tu solicitud:

JSON

{  "webhook": {    "url": "https://your-domain.com/webhook",    "metadata": {      "any_key": "any_value"    },    "events": ["iniciado", "página", "completado", "error"]  }}

Campo	Tipo	Requerido	Descripción
`url`	string	Sí	La URL de tu endpoint (HTTPS)
`headers`	object	No	Encabezados personalizados para incluir en las solicitudes del webhook
`metadata`	object	No	Datos personalizados incluidos en las cargas del webhook
`events`	array	No	Tipos de eventos a recibir (por defecto: todos los eventos)

Uso#

Rastreo con 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://tu-dominio.com/webhook",        "metadata": {          "any_key": "any_value"        },        "events": ["started", "page", "completed"]      }    }'

Raspado en lote con 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"]      }    }'

Tiempos de espera y reintentos#

Tu endpoint debe responder con un estado 2xx en un plazo de 10 segundos.

Si la entrega falla (se excede el tiempo de espera, el estado no es 2xx o hay un error de red), Firecrawl reintenta automáticamente:

Reintento	Retraso después del fallo
1.º	1 minuto
2.º	5 minutos
3.º	15 minutos

Después de 3 reintentos fallidos, el webhook se marca como fallido y no se realizan más intentos.