Vue d’ensemble

Recevez une notification dès qu’un crawl, une extraction par lot, une extraction, une tâche d’agent ou une vérification de surveillance démarre, progresse ou se termine. Au lieu d’interroger périodiquement leur état, vous fournissez un point de terminaison HTTPS et Firecrawl y envoie les événements en temps réel.

Opérations prises en charge

Opération	Événements
Crawl	`started`, `page`, `completed`
extraction par lot	`started`, `page`, `completed`
Extract	`started`, `completed`, `failed`
Agent	`started`, `action`, `completed`, `failed`, `cancelled`
Monitor	`check.completed`

Consultez les Types d’événements pour obtenir tous les détails de la charge utile et des exemples.

Configuration

Ajoutez un objet webhook à votre requête :

JSON

{
  "webhook": {
    "url": "https://your-domain.com/webhook",
    "metadata": {
      "any_key": "any_value"
    },
    "events": ["start", "page", "completed", "failed"]
  }
}

Champ	Type	Requis	Description
`url`	string	Oui	L’URL de votre endpoint (HTTPS)
`headers`	object	Non	En-têtes personnalisés à inclure dans les requêtes du webhook
`metadata`	object	Non	Données personnalisées incluses dans toutes les charges utiles du webhook
`events`	array	Non	Types d’événements à recevoir (par défaut : tous les événements)

Utilisation

Exploration avec 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": ["started", "page", "completed"]
      }
    }'

Scrape par lots avec 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"]
      }
    }'

Expirations & Réessais

Votre endpoint doit répondre avec un statut 2xx en 10 secondes maximum.

Si la livraison échoue (expiration, statut non-2xx ou erreur réseau), Firecrawl réessaie automatiquement :

Réessai	Délai après l’échec
1er	1 minute
2e	5 minutes
3e	15 minutes

Après 3 réessais infructueux, le webhook est marqué comme échoué et aucune autre tentative n’est effectuée.