Através do recurso de webhook, a plataforma enviará um POST para o endereço cadastrado no campo URL Webhook, presente no menu Configurações (https://app.contratosdigitais.com/configuracoes/) da plataforma, sempre que ocorrer uma nova assinatura no documento por parte dos signatários ou um documento for finalizado.

1440

Resposta
O servidor espera uma resposta positiva, ou seja, com o Status Code 2xx.
Todas as outras informações retornadas no cabeçalho ou no conteúdo da resposta são ignoradas.

Falhas
Caso o seu servidor retorne um erro, ou seja, com o Status Code diferente de 2xx, nossa plataforma faz novas tentativas de entrega.
Serão feitas 5 tentativas de entrega da notificação. As tentativas são feitas de hora em hora.

Eventos

Evento document.signed, onde a notificação é realizada após a assinatura de um signatário.

DadoDescrição
X-ContratosDigitais-EventEvento que gerou a notificação.
X-ContratosDigitais-Document-IdID do documento assinado pelo signatário.
X-ContratosDigitais-Signatario-IdID do signatário que efetuou a assinatura.

Payload enviado pelo webhook:

{
    "X-ContratosDigitais-Event": "document.signed",
    "X-ContratosDigitais-Document-Id": 12345,
    "X-ContratosDigitais-Signatario-Id": 67890
}

Evento document.finished, onde a notificação é realizada após a finalização do documento.

DadoDescrição
X-ContratosDigitais-EventEvento que gerou a notificação.
X-ContratosDigitais-Document-IdID do documento finalizado.

Payload enviado pelo webhook:

{
    "X-ContratosDigitais-Event": "document.finished",
    "X-ContratosDigitais-Document-Id": 12345
}

Evento document.canceled, onde a notificação é realizada após o cancelamento do documento.

DadoDescrição
X-ContratosDigitais-EventEvento que gerou a notificação.
X-ContratosDigitais-Document-IdID do documento cancelado.

Payload enviado pelo webhook:

{
    "X-ContratosDigitais-Event": "document.canceled",
    "X-ContratosDigitais-Document-Id": 12345
}