¿Qué es un Webhook?
Un webhook es un punto final HTTP que usted proporciona, y le enviaremos una solicitud POST
una vez que se complete su tarea, ya sea que haya tenido éxito o haya fallado. Esto elimina la necesidad de sondear constantemente la API y permite que su sistema reaccione en tiempo real.
Cómo usar Webhooks
Al crear una tarea, incluya un campo webhook.url
en su solicitud. Ejemplo:
{
"actor": "scraper.shopee",
"webhook": {
"url": "https://webhook.site/8fe8b27a-3902-42d9-a44e-b5e74466e475"
},
"input": {
"url": "https://shopee.tw/api/v4/pdp/get_pc?item_id=1413075726&shop_id=19675194"
}
}
Payloads de Webhook
Una vez que la tarea se completa, enviaremos el resultado a su URL de webhook mediante una solicitud POST
.
Payload de éxito
{
"response": {
"data": "base64 json string",
"encoding": "base64"
},
"state": "completed",
"success": true,
"taskId": "7a0087db-05ae-4caf-887c-67e5efcaf3d1"
}
Payload de fallo
{
"state": "completed",
"status": {
"code": 4,
"message": "context deadline exceeded"
},
"success": false,
"taskId": "d5f188a7-9d87-4f7d-8801-5a7c6083b3e6"
}
¿Aún prefiere sondear?
No hay problema, siempre puede obtener el resultado manualmente:
curl --location --request GET 'https://api.scrapeless.com/api/v1/scraper/result/{taskId}' \
--header 'x-api-token: YOUR_API_KEY' \
--header 'Content-Type: application/json'
Esto funciona independientemente de si se configuró un webhook.
Pruébelo
Pruebe su webhook instantáneamente usando Webhook.site — una herramienta gratuita que genera URL probadas y le muestra las solicitudes entrantes en tiempo real.
Preguntas frecuentes
P: ¿Reintentará el webhook si falla?
No actualmente. Asegúrese de que su punto final sea confiable y esté disponible.
P: ¿Las llamadas de webhook son sincrónicas?
No, las enviamos de forma asincrónica, por lo que no bloqueará el procesamiento de la tarea.