Pré-requisito: Certifique-se de que sua conta está configurada para receber webhooks e de que você possui uma URL pública para receber notificações.

​
Introdução

O Scanify permite que você receba notificações automáticas de conclusão de OCR por meio de webhooks. Ao configurar um webhook, você será notificado assim que o processamento do OCR estiver concluído, sem necessidade de consultar continuamente o status.

​
Configuração de webhook

Para uma configuração mais simples, você pode utilizar o painel do Scanify para configurar o webhook.

  1. Acesse o Painel do Scanify:
    • Navegue até a seção Configurações > Webhooks no painel da sua conta.
  2. Adicione a URL de Notificação:
    • No campo de URL, insira o endereço do seu servidor onde deseja receber as notificações do webhook. Exemplo: https://seuservidor.com/ocr/callback.
  3. Escolha o Evento:
    • Selecione o evento disponível na lista (atualmente, o único evento disponível é job_completed para notificação ao término do processamento de OCR).
  4. Salve as Configurações:
    • Clique em Salvar para confirmar a configuração do webhook.
    • Você verá uma mensagem de confirmação indicando que o webhook foi configurado com sucesso.

Nota: Uma vez configurado pelo painel, o Scanify automaticamente enviará notificações para o URL salvo assim que um documento for processado.

​
Recebimento de notificação

Assim que o OCR for concluído, o Scanify enviará uma requisição POST para o URL do webhook configurado, incluindo o jobId, o status do processamento e o text (conteúdo extraído).

Exemplo de Payload de Notificação:

{
  "jobId": "123456",
  "status": "completed",
  "text": "Conteúdo extraído aqui..."
}

Nota: O status poderá ser completed ou failed. No caso de falha, o campo text pode estar ausente ou incluir uma mensagem de erro.

​
Resolução de Problemas

Confira abaixo algumas soluções para problemas comuns relacionados à configuração e recebimento de notificações de webhook: