Publicado, assinado, recusado: os eventos do ciclo de vida do envelope chegam como POST no endpoint que você cadastrar, na hora em que acontecem.
Chega de varrer a API: seu sistema recebe o aviso, consulta o que precisa e segue o fluxo.
Cada passo importante do envelope vira um POST no endpoint cadastrado, e cada webhook escolhe quais eventos quer receber.
envelope.created Criado
envelope.publish_scheduled Publicação agendada
envelope.published Publicado
envelope.published_by_schedule Publicado pelo agendamento
envelope.unpublished Despublicado
envelope.updated Atualizado
envelope.signed Assinado
envelope.cancelled Cancelado
envelope.expired Expirado
envelope.viewed_by_signer Visualizou
envelope.approved_by_signer Aprovou
envelope.rejected_by_signer Recusou
envelope.cancelled_due_to_mfa_error_by_signer Cancelado por erro de MFA
Vários webhooks
Cadastre quantos webhooks precisar — um para o ERP, outro para o CRM, outro para o BI — e especifique, em cada um, qual ou quais eventos ele quer escutar.
O ERP recebe só o assinado; o CRM acompanha publicação e assinatura. Nada de filtrar eventos irrelevantes do seu lado.
Payload
O corpo do POST é enxuto: tipo do evento, ambiente e os
identificadores da conta e do envelope. Nos eventos de signatário, o
signer_id vai junto.
Nome, e-mail e conteúdo de documento ficam fora do payload. Com o ID em mãos, o seu sistema consulta a API de integração e busca só o que precisa.
{
"event_type": "envelope.signed",
"account_id": "3f9d2b71-84c6-4a0e-b52d-6c1e8f4a9b30",
"env": "production",
"envelope_id": "b4c2f8d1-3e5a-4b6c-9d7e-1f2a3b4c5d6e"
} Entrega
A entrega é gerenciada pelo Signater: cada envio fica com o status registrado, e você acompanha o que chegou e o que falhou.
Endpoint fora do ar ou respondendo erro? A entrega entra em reenvio automático, sem ninguém precisar acionar nada do seu lado.
Durante o desenvolvimento, o CLI encaminha os eventos direto para a sua máquina: você depura o handler localmente, sem publicar uma URL.
Cada chamada ao seu endpoint se identifica com o método que você configurar no cadastro do webhook.
Um segredo fixo acompanha toda chamada, no cabeçalho ou na query string, com o nome que você definir.
Usuário e senha no padrão HTTP Basic. O caminho direto quando o destino é um sistema interno ou legado.
Um token estático no cabeçalho Authorization, como nas APIs que o seu time já constrói.
Quer receber direto no API Gateway? As chamadas saem assinadas com o seu access key e secret da AWS.
Cada payload chega assinado com um segredo seu, no cabeçalho que você nomear. Confira a assinatura e descarte o que não bater.
O Signater obtém um token no seu servidor de autorização antes de entregar, nos fluxos client credentials e authorization code.
Dez eventos cobrem os principais movimentos: criação, agendamento de publicação, publicação, atualização, assinatura, cancelamento e expiração do envelope, além de visualização, aprovação e recusa por signatário. Você pode cadastrar mais de um webhook e escolher os eventos de cada um.
Sim, quantos precisar: cada webhook define qual ou quais eventos escuta — um para o ERP, outro para o CRM — sem filtrar eventos irrelevantes do seu lado.
A entrega entra em reenvio automático: o Signater repete a tentativa sem você precisar acionar nada. Enquanto isso, o status de cada entrega fica rastreável, então dá para ver o que falhou e confirmar quando o evento chegou.
Escolha entre seis métodos de autenticação ao cadastrar o webhook: chave de API, autenticação básica, token Bearer, assinatura AWS, assinatura customizada e OAuth2. O payload também ajuda: carrega apenas identificadores, sem dados pessoais nem conteúdo de documento.
Conecte o CLI e receba os eventos direto na sua máquina, sem publicar uma URL. Combinado com o modo sandbox da API, você dispara envelopes de teste isolados da produção; o campo env do payload indica de qual ambiente cada evento veio.
Fale com a equipe
Nossa equipe revisa a sua integração: quais eventos assinar, como autenticar o endpoint e o que validar com o CLI antes de ir para produção. Tire suas dúvidas direto no WhatsApp.