Guia do Usuário Cancelar

Configurar um novo webhook

 

Guia do Adobe Acrobat Sign

Novidades

Introdução

Administrar

Enviar, assinar e gerenciar contratos

Recursos e fluxos de trabalho avançados de contratos

Integrar a outros produtos

Acrobat Sign Developer

Suporte e solução de problemas

Opções de configuração

A configuração do webhook requer a definição de cinco elementos:

  • Nome : sugerimos um nome intuitivo que outros administradores possam entender prontamente.
  • Escopo - Qual é o alcance de captura do webhook? Conta e Grupo estão disponíveis na interface.
    • A API é compatível com os escopos de Recurso, Conta, Grupo e Usuário.
    • Somente um escopo pode ser definido por webhook.
  • URL - O URL de destino para o qual o Acrobat Sign enviou o conteúdo JSON.
  • Eventos - O acionador que faz com que o Acrobat Sign crie o JSON e o envie para o URL.
    • Cada evento cria um conteúdo diferente que seja relevante para o evento de acionamento.
    • Vários Eventos podem ser incluídos em um webhook.
  • Parâmetros de notificação - Os parâmetros de notificação identificam as seções do conteúdo JSON do evento, permitindo que você selecione apenas as seções do evento que são importantes para este webhook (reduzindo assim o número de dados desnecessários enviados para seu URL).

Quando o webhook estiver totalmente definido, clique em Salvar e o novo webhook começará a reagir para acionar eventos imediatamente. 

Observação:

Configure o URL do webhook para responder às solicitações de verificação e notificação do webhook conforme o protocolo de verificação explicado acima. A ID do cliente (ID do Aplicativo) que será enviada para webhooks criados no aplicativo web do Acrobat Sign será - UB7E5BXCXY

Configurar o webhook

Escopos

  • Conta: todos os eventos inscritos que ocorrem na conta acionam o push.
    • Os administradores da conta têm autoridade para ver todos os webhooks definidos para a conta e todos os grupos dentro dela.
  • Grupo: todos os eventos inscritos que ocorrem no grupo acionam o push. OBSERVAÇÃO: Os webhooks com escopo de grupo existem apenas para esse grupo.
    • Os administradores do grupo verão apenas os webhooks dedicados ao seu grupo. Eles não podem ver os webhooks no nível da conta ou webhooks vinculados a outros grupos.
    • As contas com a opção Usuários em vários grupos ativada verão a opção de selecionar o grupo ao qual o escopo deve ser aplicado.
  • Conta de usuário: todos os eventos inscritos para uma conta de usuário acionam o push. Os webhooks no nível do usuário só podem ser criados por meio da API.
  • Webhook de nível de recurso: isso será criado para um recurso específico. Os eventos específicos deste recurso serão enviados para a URL do webhook. Os webhooks no nível do recurso só podem ser criados por meio da API.

URL

Um URL de webhook é um servidor que escuta mensagens de notificação de POST HTTPS de entrada que são acionadas quando ocorrem eventos.

Você precisa desse URL para inscrever seu webhook para eventos.

  • O cliente deve incluir um URL HTTPS ao qual o Acrobat Sign possa fazer solicitações POST. Este URL deve estar disponível na Internet pública.  
    • Por exemplo, os URIs 127.0.0.1 e localhost não funcionarão.
    • O ponto de acesso do URL deve estar acompanhando a porta 443 ou 8443 (isso é decidido pelo cliente ao definir o URL do callback).
  • Verifique se o webhook oferece suporte a solicitações POST para notificações de evento de entrada e solicitações GET para a solicitação de verificação.
  • O URL não deve ser bloqueado por um firewall.

Eventos

Abaixo estão os eventos que podem acionar um push para o URL do webhook, agrupados por objeto e listados na ordem em que são encontrados na interface.

O valor à esquerda é o valor que você verá na interface do Acrobat Sign. O valor à direita é o nome do webhook na API.

Para obter detalhes completos sobre os webhooks e seus conteúdos, consulte o Guia dos desenvolvedores do Acrobat Sign.

Contratos:

Elemento de interface Nome do webhook
Todos os eventos do contrato AGREEMENT_ALL
Contrato criado AGREEMENT_CREATED
Contrato enviado AGREEMENT_ACTION_REQUESTED
Participação no contrato concluída AGREEMENT_ACTION_COMPLETED
Fluxo de trabalho do contrato concluído AGREEMENT_WORKFLOW_COMPLETED
O contrato expirou AGREEMENT_EXPIRED
Contrato excluído AGREEMENT_DOCUMENTS_DELETED
Contrato cancelado AGREEMENT_RECALLED
Contrato rejeitado AGREEMENT_REJECTED
Contrato compartilhado AGREEMENT_SHARED
Compartilhamento de contrato cancelado AGREEMENT_UNSHARE
Compartilhamento de contrato cancelado automaticamente AGREEMENT_UNSHARE_AUTO
O contrato foi delegado AGREEMENT_ACTION_DELEGATED
Participante do contrato substituído AGREEMENT_ACTION_REPLACED_SIGNER
Contrato modificado AGREEMENT_MODIFIED
Modificação no contrato reconhecida AGREEMENT_USER_ACK_AGREEMENT_MODIFIED
Email do contrato visualizado AGREEMENT_EMAIL_VIEWED
O email do contrato retornou AGREEMENT_EMAIL_BOUNCED
Documento do contrato exibido AGREEMENT_DOCUMENTS_VIEWED
Documento do contrato exibido após aplicar uma senha para visualizá-lo AGREEMENT_DOCUMENTS_VIEWED_PASSWORD_PROTECTED
Falha na criação do contrato AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM
Contrato sincronizado pós evento offline AGREEMENT_OFFLINE_SYNC
Contrato arquivado AGREEMENT_VAULTED
Identidade social do participante do contrato autenticada AGREEMENT_WEB_IDENTITY_AUTHENTICATED
KBA do participante do contrato autenticado AGREEMENT_KBA_AUTHENTICATED
Email de participante do contrato autenticado por OTP
AGREEMENT_EMAIL_OTP_AUTHENTICATED
Expiração do contrato atualizada AGREEMENT_EXPIRATION_UPDATED
Lembrete de contrato enviado AGREEMENT_REMINDER_SENT
Nome do signatário do contrato alterado pelo signatário AGREEMENT_SIGNER_NAME_CHANGED_BY_SIGNER
Lembrete de contrato iniciado AGREEMENT_REMINDER_INITIATED
O contrato dos Webhooks está disponível somente via API
Elemento de interface Nome do webhook
N/A
AGREEMENT_READY_TO_NOTARIZE
N/A
AGREEMENT_READY_TO_VAULT

 

Envio em massa:

Elemento de interface Nome do webhook
Enviar em massa todos os eventos MEGASIGN_ALL
Enviar em massa os criados
MEGASIGN_CREATED
Enviar em massa os compartilhados
MEGASIGN_SHARED
Enviar em massa os recuperados
MEGASIGN_RECALLED
Lembrete de envio em massa enviado MEGASIGN_REMINDER_SENT
Lembrete de envio em massa iniciado MEGASIGN_REMINDER_INITIATED

 

Formulários Web:

Elemento de interface Nome do webhook
Fazer formulário Web de todos os eventos WIDGET_ALL
Formulário Web criado
WIDGET_CREATED
Formulário Web habilitado
WIDGET_ENABLED
Formulário Web desabilitado
WIDGET_DISABLED
Formulário Web modificado
WIDGET_MODIFIED
Formulário Web compartilhado
WIDGET_SHARED
Falha na criação do formulário Web
WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM

 

Modelos de biblioteca (somente API):

Elemento de interface Nome do webhook
N/A LIBRARY_DOCUMENT_ALL
N/A LIBRARY_DOCUMENT_CREATED
N/A LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM
N/A LIBRARY_DOCUMENT_MODIFIED

 

Parâmetros de notificação

Os Parâmetros de Notificação permitem personalizar a carga JSON apenas para elementos específicos do evento.

Por exemplo, em um evento de Substituição do participante do contrato, você pode querer apenas as Informações do contrato e as Informações do participante, deixando de fora as Informações do documento e reduzindo o volume total do JSON enviado ao URL do webhook.

 

  • Contrato
    • Informações do contrato — informações detalhadas do contrato com base no estado do contrato no momento do evento de acionamento.
    • Informações do documento do contrato — inclui qualquer informação de documento gerada como resultado do evento.
    • Informações do Participante do Contrato — inclui qualquer informação do participante como resultado do evento.
    • Documento assinado do contrato : fornece o PDF assinado. 
      • Aplicável aos eventos Fluxo de trabalho do contrato concluído Todos os contratos.
  • Envio em massa
    • Informações de Envio em massa — informações detalhadas sobre o objeto de Envio em massa que acionou o evento.
  • Formulário web
    • Informações do dispositivo : informações detalhadas sobre o formulário web que acionou o evento.
    • Informações do documento do widget — as informações do documento associadas ao modelo de formulário web.
    • Informações do participante do dispositivo — informações sobre os participantes definidos no modelo de formulário web.

Receba ajuda com mais rapidez e facilidade

Novo usuário?