Webhooks SantoID
Os webhooks permitem o recebimento assíncrono de resultados de processamento diretamente em seus sistemas.
Visão Geral
Configuração Básica
- Cadastre seu endpoint no SantoID
- Garanta que retorne HTTP 200 para sucesso
- Configure e-mail para monitoramento
Requisitos
- Endpoint HTTPS
- Tempo de resposta < 5s
- Capacidade de receber JSON
Tratamento de Erros
1. Falha na Entrega
Quando ocorre:
Endpoint indisponível ou sem resposta
Ações:
- 5 tentativas de reenvio
- Intervalos de 10 minutos
- Notificação por e-mail
Política de Notificação:
| Situação | Notificação Após |
|---|---|
| Primeira falha | 3 horas sem sucesso |
| Erro persistente | 24 horas sem sucesso |
2. Erro Interno
Quando ocorre:
Falha no processamento pelo SantoID
Diferenças:
- Notificação imediata
- Mensagem enviada mesmo com erro
- Padrão de resposta mantido
Estrutura das Respostas
- OCR
- Tipificação
- Validação
- Workflow
Políticas e Garantias
- Armazenamento: Mensagens ficam na fila por 7 dias
- Criptografia: TLS 1.2+ obrigatório
- Timeout: 30 segundos por tentativa
Melhores Práticas
- Implemente idempotência no seu endpoint
- Mantenha logs de todas as requisições
- Teste com ferramentas como webhook.site
- Monitore os e-mails de notificação