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
  • 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

Eventos

Entenda os eventos recebidos via webhooks

Lista de eventos

A ZapSign envia os seguintes eventos por webhook:

  • doc_created Este evento é enviado quando um documento é criado.

  • created_signer Este evento é enviado quando um novo signatário é adicionado a um documento em andamento.

  • doc_deleted Notifica quando um documento foi excluído, seja pela plataforma ou via API.

  • doc_signed Acionado quando um signatário assina o documento. O webhook especifica qual signatário assinou o documento.

  • doc_refused Indica que um documento foi recusado pelo signatário.

  • email_bounce Notifica sobre falhas na entrega de e-mails.

  • signature_notification_sent Notifica quando o documento é enviado ao signatário por e-mail ou WhatsApp (parâmetro send_automatic_email ou send_automatic_whatsapp).

  • doc_viewed Notifica quando o signatário visualizou o documento (abriu o link de assinatura).

  • doc_read_confirmation Notifica quando o signatário confirma a leitura do documento (botão "Continuar" após visualizar o documento).

  • signer_authentication_failed Notifica quando o signatário excedeu o número máximo de tentativas para validar sua identidade através dos métodos Reconhecimento Facial e Validação de Identidade.

Você poderá diferenciar um do outro pelo atributo "event_type" que seguirá junto de todo webhook.

"event_type": "doc_created"

Veja o body de cada evento nos próximos capítulos!

PreviousLogs de WebhooksNextDocumento

Last updated 1 month ago

Was this helpful?