These docs are for v1.0. Click to read the latest docs for v3.0.

Eventos

Quando ocorrerem eventos nos documentos, uma requisição HTTP POST será disparada para a URL previamente cadastrada nas configurações da conta. Veja mais em Cadastro de Webhooks.

Listagem dos eventos que disparam Webhooks:

EventoDescrição
add_imageOcorre quando é realizado um evento customizado de imagem para um documento.
add_signerOcorre quando são adicionados signatários a um documento.
attempts_by_whatsapp_exceededOcorre quando as tentativas de reenvio de Token via WhatsApp são excedidas.
facematch_refusedOcorre quando a análise da Biometria Facial realizada pela CAF é rejeitada.
auto_closeOcorre quando um documento é finalizado automaticamente logo após a última assinatura.
cancelOcorre quando um documento é cancelado manualmente.
closeOcorre quando um documento é finalizado manualmente.
customOcorre quando é realizado um evento customizado de token (e-mail, sms) para um documento.
deadlineOcorre quando a data limite de assinatura de um documento for atingida. Se o documento contiver ao menos uma assinatura, ele é finalizado. Caso contrário, o documento é cancelado.
refusalOcorre quando um documento é recusado.
remove_signerOcorre quando são removidos signatários de um documento.
signOcorre quando um signatário assina um documento.
update_auto_closeOcorre quando a opção de finalização automática de um documento é alterada.
update_deadlineOcorre quando a data limite de assinatura de um documento é alterada.
uploadOcorre quando é realizado o upload de um documento.