Webhooks - Como Funciona
Webhooks sao notificacoes automaticas que a TapSign envia para a sua aplicacao sempre que um evento relevante acontece. Em vez de ficar consultando a API repetidamente para verificar mudancas (polling), voce recebe a informacao em tempo real.
Como funciona na pratica
- Voce registra uma URL no painel ou via API
- Escolhe quais eventos deseja receber
- Quando o evento acontece, a TapSign envia um POST para a sua URL
- Sua aplicacao processa a notificacao e retorna HTTP 200
┌─────────┐ evento ┌─────────┐ POST ┌──────────────┐
│ TapSign │ ──────────► │ Webhook │ ─────────► │ Sua Aplicacao│
└─────────┘ │ Engine │ └──────────────┘
└─────────┘ │
│ HTTP 200
◄──────────────────────────┘
Beneficios
| Abordagem | Polling | Webhooks |
|---|---|---|
| Tempo real | Nao (depende do intervalo) | Sim |
| Consumo de API | Alto (muitas requisicoes) | Baixo (so quando necessario) |
| Complexidade | Precisa gerenciar loop | Recebe automaticamente |
| Custo | Mais requests = mais custo | Eficiente |
Disponivel em todos os planos
Webhooks estao disponiveis para todos os planos da TapSign, sem custo adicional.
Eventos disponiveis
A TapSign suporta webhooks para os seguintes tipos de eventos:
Envelope
| Evento | Descricao |
|---|---|
envelope.created | Envelope foi criado |
envelope.sent | Envelope foi enviado para assinatura |
envelope.completed | Todos os signatarios assinaram |
envelope.canceled | Envelope foi cancelado |
envelope.expired | Envelope expirou sem todas as assinaturas |
Signatario
| Evento | Descricao |
|---|---|
signer.notified | Signatario foi notificado |
signer.viewed | Signatario visualizou o documento |
signer.signed | Signatario assinou o documento |
signer.declined | Signatario recusou assinar |
Documento
| Evento | Descricao |
|---|---|
document.uploaded | Documento foi enviado ao envelope |
Sua aplicacao deve retornar HTTP 200
Quando a TapSign envia um webhook, ela espera receber um HTTP 200 como resposta. Caso contrario, a entrega sera considerada falha e a TapSign tentara reenviar automaticamente seguindo a politica de retentativas.
Proximos passos
- Criar Webhook - Registre sua primeira URL
- Eventos - Veja o payload completo de cada evento
- Logs de Entrega - Monitore as entregas
- Verificacao de Assinatura - Valide a autenticidade dos webhooks
- Excluir Webhook - Remova webhooks que nao precisa mais