O que é um Webhook?

Um webhook é um endpoint HTTP que você fornece, e nós enviaremos uma requisição POST para ele assim que sua tarefa for concluída — seja ela bem-sucedida ou não. Isso elimina a necessidade de consultar constantemente a API e permite que seu sistema reaja em tempo real.

Como usar Webhooks

Ao criar uma tarefa, inclua um campo webhook.url em sua requisição. Exemplo:

{
  "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 do Webhook

Assim que a tarefa estiver concluída, enviaremos o resultado para sua URL do webhook via POST.

Payload de Sucesso

{
  "response": {
    "data": "base64 json string",
    "encoding": "base64"
  },
  "state": "completed",
  "success": true,
  "taskId": "7a0087db-05ae-4caf-887c-67e5efcaf3d1"
}
 

Payload de Falha

{
  "state": "completed",
  "status": {
    "code": 4,
    "message": "context deadline exceeded"
  },
  "success": false,
  "taskId": "d5f188a7-9d87-4f7d-8801-5a7c6083b3e6"
}
 

Ainda prefere consultar manualmente?

Não tem problema — você sempre pode buscar o 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'
 

Isso funciona independentemente de um webhook ter sido definido ou não.

Experimente

Teste seu webhook instantaneamente usando Webhook.site — uma ferramenta gratuita que gera URLs testáveis e mostra as requisições recebidas em tempo real.

FAQ

P: Vocês tentarão novamente o webhook se ele falhar?

Atualmente não. Certifique-se de que seu endpoint seja confiável e esteja disponível.

P: As chamadas de webhook são síncronas?

Não — nós as enviamos de forma assíncrona, então isso não bloqueará o processamento da tarefa.