ZapSign API
Português
Português
  • Informações gerais
  • Como começar
  • Ambiente de testes
  • Todas as requisições prontas!
  • Autenticação
    • Token estático (Api Token)
    • JWT (recomendado)
      • Obter token de acesso
      • Atualize seu token de acesso
  • Tipos de Tokens e Como Localizá-los
  • Versionamento da API
  • Políticas de Rate Limit
  • Alerta de incidentes
  • Ambiente de produção: Como funciona o pagamento
  • Status de erros
  • Conta
    • Informações do Plano
    • Listar usuários da conta
    • Criar usuários na conta
    • Excluir usuário da conta
  • Documentos
    • Criar documento via Upload
    • OneClick (ClickWrap)
      • Criar documento (OneClick)
    • Criar documento via Modelo
    • Adicionar anexo (documento extra)
    • Adicionar anexo (documento extra) via Modelo
    • Detalhar documento
    • Listar documentos
    • Excluir documento
    • Histórico de atividades do documento
    • Opcional: Posicionar assinaturas
    • Reprovar documentos
    • Validação de assinaturas
  • Signatários
    • Detalhar signatário
    • Atualizar signatário
    • Adicionar signatário
    • Excluir signatário
    • Grupo de signatários
      • Definir grupos de signatários
      • Excluir grupos de signatários
    • Assinar em lote via API
    • Reprovar documentos pelo usuário
  • Modelos
    • Criar modelo DOCX
      • Atualizar formulario
    • Listar modelos
    • Detalhar modelo
    • Atualizar modelo
    • Excluir modelo
  • Antecedentes
    • Introdução
    • Entendendo o Resultado
    • Criar uma Consulta (Check)
      • Consulta de Pessoa
      • Consulta de Empresa
  • Consultar Check
  • Detalhe do Check
  • Parcerias
    • Atualizar status de pagamento
  • Criar conta
  • CARIMBO DE TEMPO
    • Como funciona Carimbo de Tempo?
    • Carimbo de Tempo padrão
    • Carimbo de tempo preservando a assinatura original
  • Webhooks
    • Como funcionam os Webhooks
    • Testando Webhooks
    • Criar webhook
    • Logs de Webhooks
    • Eventos
      • Documento
        • Documento criado
        • Documento removido
        • Signatário criado
      • Signatário
        • Notificação de assinatura
        • Documento visualizado
        • Confirmação de leitura
        • Documento assinado
        • Documento recusado
        • Email bounce
        • Falha na Validação
      • Antecedentes
        • Consulta concluída
    • Reprocessamento de Documentos e Webhooks
    • Deletar webhook
  • Widget
    • Como funciona o Widget
Powered by GitBook
On this page

Was this helpful?

  1. Webhooks

Como funcionam os Webhooks

PreviousCarimbo de tempo preservando a assinatura originalNextTestando Webhooks

Last updated 8 months ago

Was this helpful?

Webhooks são notificações automáticas essenciais para a integração entre sistemas, pois notificam diretamente o seu servidor, eliminando a necessidade de verificar constantemente o status de uma operação.

Com os webhooks você pode:

  • Reduzir de Consultas Repetitivas à API para saber o status de um documento (prática comumente chamada de polling;

  • Sincronizar Sistemas e Integrações, garantindo que informações entre diferentes plataformas estejam sempre atualizadas e consistentes.

  • Automatizar Processos Pós-Evento, para que tarefas subsequentes sejam feitas automaticamente!

Preciso ter um Plano de API para usar webhooks? Não, os webhooks estão disponíveis gratuitamente para todos os usuários. No entanto, recomendamos fortemente que os usuários da API utilizem webhooks em vez de fazer polling.


A Zapsign oferece suporte a webhooks para que você seja notificado de eventos como criação, assinatura, documento rejeitado, conclusão de documentos ou falha na entrega de email. Quando um evento desse tipo ocorre, enviamos uma requisição HTTP POST para o URL configurado em sua aplicação, contendo detalhes sobre o evento em formato JSON.

A sua aplicação deve retornar o status 200 quando receber um webhook, caso contrário a ZapSign irá retentar o envio, gerando duplicidades e/ou requisições desnecessárias.

O fluxo básico de um webhook.
fluxograma em azul mostrando como é o fluxo básico de criação de um webhook.