Pular para o conteúdo principal

Webhooks

Você pode configurar Webhooks para receber dados referentes ao variados tipos de eventos que acontecem referente aos processos de assinatura de seu Tenant.

Dados da Listagem​

Lista de Webhooks

Cada Webhook listado na tabela seguirá a seguinte ordem de informações:

  • Descrição: Descrição sobre o Webhook.
  • Empresa: Empresa à qual o Webhook enviará eventos relacionados.
  • Status: Indica o status atual do Webhook.
  • Ações: Você terá botões de ação específicos para cada Webhook.
    • Editar

      Abre a tela para editar os dados do Webhook selecionado.

    • Revogar

      Exclui permanentemente o Webhook selecionado. Esta ação é irreversível.

Criar/Editar Webhook​

Criar Webhooks

Caso você esteja criando um novo Webhook ou editando um Webhook existente você encontrará uma tela com os seguintes campos:

aviso

Campos marcados com * são de preenchimento obrigatório. Os demais campos podem permanecer em branco, embora isso não seja recomendado.

  • ID Externa: Identificador externo definido pelo usuário.
  • Descrição: Descrição de texto sobre o Webhook.
  • URL de Payload: Endereço para o qual os eventos do Webhook serão enviados.
  • Empresa: Empresa à qual o Webhook estará vinculado e sobre a qual irá monitorar eventos.
  • Ativo: Define se o Webhook está ativo ou não.
  • Eventos: Selecione um ou mais eventos que o Webhook deverá monitorar:
    • Assinatura solicitada: Acionado quando for realizada uma nova solicitação de assinatura de documentos.
    • Alterações no processo: Acionado quando houver qualquer alteração de testemunhas ou modificação no endereço de email dos assinantes de um processo de assinatura.
    • Assinatura realizada: Acionado quando algum assinante conclui a assinatura de um documento.
    • Rejeição de assinatura: Acionado quando algum assinante recusa a assinatura de um documento.
    • Assinatura cancelada: Acionado quando a assinatura de um documento é cancelada, incluindo o cancelamento total do processo de assinatura.
    • Documento assinado: Acionado quando todos os assinantes concluem suas assinaturas e o documento já está disponível para visualização.
    • Download solicitado: Acionado quando for solicitada a geração de download de um ou mais documentos.
    • Download disponível: Acionado quando o download solicitado estiver disponível para acesso.
  • Headers Personalizados: Permite adicionar cabeçalhos personalizados que serão enviados junto aos eventos do Webhook:
    • Header: Nome do cabeçalho a ser enviado. Exemplo: Authorization.
    • Valor: Valor correspondente ao cabeçalho. Exemplo: Bearer abc123.
    • +: Salva o cabeçalho personalizado e libera os campos para a adição de um novo.
aviso

A URL informada deverá obrigatoriamente aceitar o método POST do protocolo HTTP.

observação

Ao salvar o Webhook, o sistema enviará um evento PING para a URL de Payload informada, a fim de testar a comunicação e validar a conexão com o endpoint configurado.