Pular para conteúdo

🔔 Webhooks

Os webhooks permitem que seu sistema receba notificações automáticas e em tempo real sobre eventos importantes relacionados à assinatura eletrônica de documentos. Com eles, é possível integrar fluxos, automatizar tarefas e manter sistemas sincronizados.

O que é um Webhook?

Um webhook é um mecanismo que envia requisições HTTP POST para uma URL definida por você sempre que um evento relevante ocorre nos seus Processos e/ou Signatários. O payload é enviado em formato JSON, facilitando a integração com qualquer linguagem ou plataforma.

Eventos de Webhook

Código do Evento Descrição
ALL Todos
PROCESS_CREATED Processo Criado
PROCESS_VIEWED Processo Visualizado
PROCESS_SIGNED Processo Finalizado
PROCESS_REMOVED Processo Removido
SIGNER_CREATED Signatário Criado
SIGNER_AUTH_FAILED Falha na Autenticação do Signatário
SIGNER_SIGNED Signatário concluiu a assinatura
SIGNER_REMOVED Signatário Removido

📥 HTTP 200 Resposta enviada com sucesso!

{
  "uid": "75dc3ef5-96ea-48e8-a8d5-178e25063912",
  "file": "https://api.autosign.com.br/75dc3ef5-96ea-48e8-a8d5-178e25063912/example.pdf",
  "name": "bla",
  "user": 1,
  "event": "EVENT_PROCESS_CREATED",
  "signers": [
    {
      "uid": "db89d0ce-8d65-4687-824c-9b4fa7718405",
      "email": "teste@gmail.com",
      "auth_type": "EMAIL",
      "full_name": "João da Silva",
      "send_type": "EMAIL",
      "signer_type": "Contratante"
      /* outros campos omitidos para simplicidade */
    }
  ],
  "deadline": "2025-05-07T22:07:51.535284-03:00",
  "process_status": "PENDING"
  /* outros campos omitidos para simplicidade */
}

Como funciona o fluxo do webhook

  1. Cadastro do webhook: Escolha o Tipo de Evento e informe a URL do endpoint que receberá as notificações.
  2. Envio do evento: Sempre que um evento ocorrer, nós enviamos uma requisição HTTP POST para a URL cadastrada, com o corpo em JSON.
  3. Processamento: Seu sistema processa o evento e retorna HTTP 200 OK para confirmar o recebimento.
  4. Reenvio em caso de falha: Se não houver resposta ou ocorrer erro, o sistema tentará reenviar a notificação após 02 (duas) horas. Caso o erro persista, é necessário realizar o reprocessamento de forma manual.

Boas práticas

  • Sempre retorne HTTP 200 OK ao processar o webhook com sucesso.
  • Registre logs dos eventos recebidos para auditoria e troubleshooting.
  • Implemente tratamento de duplicidade, pois eventos podem ser reenviados.

Exemplos de uso

  • Atualizar o status de documentos em sistemas internos.
  • Notificar usuários sobre documentos assinados ou pendentes.
  • Integrar a assinatura eletrônica com sistemas de gestão, ERP ou CRM.
  • Automatizar fluxos de aprovação e arquivamento de documentos.

Importante

Todos os eventos de webhook são enviados como requisições HTTP POST com payload em JSON e esperam uma resposta HTTP 2xx