POST/v1/crawl/:id/webhook

Attach a webhook

Attaches a webhook URL to an existing crawl job. When the crawl completes, Netleaf will POST the full results to this URL. Retries up to 3 times with exponential backoff on failure. Returns 409 if the job already finished.

Request body

Name	Type	Required	Description
webhookUrl	string	required	HTTPS endpoint to receive the crawl payload

Example

bash

curl -X POST http://localhost:3000/v1/crawl/c3d4e5f6-.../webhook \
  -H "Content-Type: application/json" \
  -d '{"webhookUrl":"https://your-app.com/hook"}'

Response

bash

{ "success": true }

Try it

Live preview only works when the API is running on your machine.

Run docker compose up and the Try-It panel will become interactive. Until then, copy the curl example below.

Poll crawl status Discover URLs