Visão geral dos webhooks do Acrobat Sign

Visão geral

Um webhook é uma solicitação HTTPS definida pelo usuário que é acionada quando um evento inscrito ocorre no site de origem (neste caso, o Adobe Acrobat Sign).

Basicamente, um webhook é um serviço REST que aceita dados ou um fluxo de dados.

Os webhooks são destinados para comunicação serviço a serviço em um modelo de PUSH.

Quando um evento inscrito é acionado, o Acrobat Sign constrói um POST HTTPS com um corpo JSON e o envia ao URL especificado.

Antes de configurar webhooks, certifique-se de que sua rede aceitará os intervalos de IP necessários para a funcionalidade.

Os webhooks oferecem vários benefícios em relação ao método de callback anterior, entre eles:

• Os administradores podem ativar seus webhooks sem precisar envolver o suporte do Acrobat Sign para listar o URL do callback
• Os webhooks oferecem dados mais atualizados, mais eficiência de comunicação e segurança. Não há necessidade de sondagem
• Os webhooks permitem diferentes níveis de escopo (Conta/Grupo/Usuário/Recurso) com facilidade. 
• Os webhooks são uma solução de API mais moderna, permitindo uma configuração mais fácil de aplicativos modernos
• Vários webhooks podem ser configurados por escopo (Conta/Grupo/Usuário/Recurso), enquanto os callbacks precisavam ser exclusivos
• Os webhooks permitem selecionar os dados a serem retornados, enquanto os callbacks são uma solução “tudo ou nada”
• Os metadados transportados com um webhook podem ser configurados (básicos ou detalhados)
• Os webhooks são muito mais fáceis de criar, editar ou desativar conforme necessário, já que a interface está totalmente sob o controle do administrador.

Pré-requisitos

Você deve permitir os intervalos de IP dos webhooks na segurança da rede para que o serviço funcione. 

O serviço de URL de retorno de chamada herdado em REST v5 usa os mesmos intervalos de IP que o serviço de webhook.

Como usar

Os administradores precisarão primeiro de um serviço de webhook pronto para aceitar o push de entrada do Acrobat Sign. Há muitas opções a esse respeito e, desde que o serviço possa aceitar solicitações POST e GET, o webhook terá êxito.

Quando o serviço estiver em funcionamento, um administrador do Acrobat Sign poderá criar um novo webhook na interface do Webhook no menu Conta, do site do Acrobat Sign.

Os administradores podem configurar o acionamento do webhook para eventos de Contrato, Formulário web (Widget) ou Envio em massa (MegaSign). O recurso Modelo de biblioteca (Documento da biblioteca) também pode ser configurado por meio da API.

O escopo do webhook pode incluir a conta inteira ou grupos individuais por meio da interface do administrador. A API permite mais granularidade por meio da seleção dos escopos USUÁRIO ou RECURSO.

O tipo de dados que é enviado ao URL é configurável e pode incluir itens como informações do contrato, do participante, do documento e assim por diante.

Depois que o webhook é configurado e salvo, o Acrobat Sign envia um novo objeto JSON ao URL definido sempre que o evento inscrito é acionado. Nenhuma manipulação contínua do webhook é necessária, a menos que você queira alterar os critérios do acionador do evento ou a carga JSON.

Verificação de intenção do URL do webhook

Antes de registrar um webhook com sucesso, o Acrobat Sign verifica se o URL do webhook fornecido na solicitação de registro realmente deseja receber notificações ou não. Para essa finalidade, quando o Acrobat Sign recebe uma nova solicitação de registro de webhook, ele primeiro faz uma solicitação de verificação ao URL do webhook. Esta solicitação de verificação é uma solicitação GET HTTPS enviada ao URL do webhook. Ela tem um cabeçalho HTTP personalizado X-AdobeSign-ClientId. O valor desse cabeçalho é definido como a ID do cliente (ID do aplicativo) do aplicativo da API que está solicitando a criação/registro do webhook. Para registrar um webhook com sucesso, o URL do webhook deve responder a essa solicitação de verificação com um código de resposta 2XX E, além disso, ele DEVE enviar de volta o mesmo valor de ID de cliente de uma de duas maneiras:

• Em um cabeçalho de resposta X-AdobeSign-ClientId. Esse é o mesmo cabeçalho transmitido na solicitação e repetido na resposta.
• Ou no corpo da resposta JSON, com a chave de xAdobeSignClientId e seu valor sendo a mesma ID de cliente enviada na solicitação.

O webhook será registrado com êxito apenas em uma resposta de sucesso (código de resposta 2XX) e validação da ID do cliente no cabeçalho ou no corpo da resposta. A finalidade dessa solicitação de verificação é demonstrar que o URL do webhook realmente deseja receber notificações nesse URL. Se você inseriu acidentalmente o URL errado, ele não responderá corretamente à solicitação de verificação de intenção e o Acrobat Sign não enviará nenhuma notificação para esse URL. Além disso, o URL do webhook também pode validar que ele receberia notificações apenas por meio dos webhooks registrados por um aplicativo específico. Isso pode ser feito validando a ID do cliente do aplicativo passado no cabeçalho X-AdobeSign-ClientId. Se o URL do webhook não reconhecer essa ID de cliente, ele NÃO DEVERÁ responder com o código da resposta de sucesso e o Acrobat Sign cuidará para que o URL não seja registrado como um webhook.

A verificação da chamada de URL do webhook será feita nos seguintes cenários:

• Registro do webhook: se essa verificação da chamada de URL do webhook falhar, o webhook não será criado.
• Atualização do webhook: INATIVO para ATIVO: se essa verificação da chamada de URL do webhook falhar, o estado do webhook não será alterado para ATIVO.

Como responder a uma notificação de webhook

O Acrobat Sign executa uma verificação implícita de intenção em cada solicitação de notificação do webhook enviada ao URL do webhook. Assim, cada solicitação HTTPS de notificação do webhook também contém o cabeçalho HTTP personalizado chamado X-AdobeSign-ClientId. O valor desse cabeçalho é a ID do cliente (ID do aplicativo) do aplicativo que criou o webhook. Consideraremos que a notificação do webhook foi entregue com êxito apenas se uma resposta de sucesso (código de resposta 2XX) for retornada e a ID do cliente for enviada no cabeçalho HTTP (X-AdobeSign-ClientId) ou por meio de um corpo de resposta JSON que contém xAdobeSignClientId como chave e a mesma ID de cliente como valor. Caso contrário, tentaremos enviar a notificação novamente para o URL do webhook até que as tentativas sejam esgotadas.

Como ativar ou desativar

O acesso ao recurso Webhooks fica ativado por padrão para contas corporativas.

Os administradores de nível de grupo podem criar/controlar apenas os webhooks que operam no grupo deles.

O acesso à página do webhooks pode ser encontrado no painel esquerdo do menu Administrador.

Limitação de taxa baseada em simultaneidade

Os eventos de criação e notificação de webhook (e retorno de chamada) são limitados em termos do número de notificações simultâneas que estão sendo ativamente entregues ao cliente pelo sistema do Acrobat Sign. Esse limite aplica-se à conta, incluindo todos os grupos dentro da conta.
Esse tipo de limitação de taxa evita que uma conta mal projetada consuma uma quantidade desproporcional de recursos do servidor, afetando negativamente todos os outros clientes naquele ambiente.

O número de eventos simultâneos por conta foi calculado para garantir que contas com webhooks com comportamento correto recebam suas notificações no tempo mais curto possível e raramente encontrem uma situação em que as notificações sejam atrasadas devido a um excesso de solicitações. Os limites atuais são:

Práticas recomendadas

• Inscreva-se em eventos específicos e necessários para limitar o número de solicitações HTTPS ao servidor - quanto mais específicos forem seus webhooks, menor será o volume necessário para examinar.
• Seja resistente a duplicidades - se você tiver mais de um aplicativo compartilhando o mesmo URL do webhook e o mesmo usuário mapeado para cada aplicativo, o mesmo evento será enviado para o webhook várias vezes (uma vez por aplicativo). Em alguns casos, o webhook pode receber eventos duplicados. Seu aplicativo de webhook deve ser tolerante a isso e remover as duplicidades por ID de evento.
• Sempre responda a webhooks rapidamente - seu aplicativo tem apenas dez segundos para responder a solicitações de webhook. Para a solicitação de verificação, isso raramente é um problema, já que seu aplicativo não terá nenhum trabalho de fato para responder. No entanto, para solicitações de notificação, seu aplicativo geralmente fará algo que consome tempo em resposta à solicitação. É recomendável trabalhar em um thread separado ou de forma assíncrona usando uma fila para garantir que você possa responder dentro de cinco segundos
• Gerenciar concorrência - quando um usuário faz várias alterações numa sequência rápida, é provável que o aplicativo receba várias notificações para o mesmo usuário, aproximadamente ao mesmo tempo. Se você não tiver cuidado com o gerenciamento de concorrência, seu aplicativo pode acabar processando as mesmas alterações do mesmo usuário mais de uma vez. Para aproveitar os webhooks do Acrobat Sign, é necessário entender claramente o uso das informações. Faça perguntas como: 
  • Quais dados você deseja que retornem na carga? 
  • Quem terá acesso a estas informações? 
  • Que decisões ou relatórios serão gerados?
• Recomendações para recebimento de um documento assinado - há vários fatores a serem considerados ao determinar como receber um PDF assinado do Acrobat Sign no sistema de gerenciamento de documentos. 

Embora seja perfeitamente aceitável apenas selecionar a opção Documento assinado do contrato ao criar um webhook, você pode considerar o uso da API do Acrobat Sign para recuperar os documentos quando um evento de acionamento (como status de contrato concluído) é recebido.

Itens a serem considerados...

Limitação de tamanho JSON

O tamanho da carga JSON é limitado a 10 MB.

Se um evento gerar uma carga maior, um webhook será acionado, mas os atributos do parâmetro condicional, se houver na solicitação, serão removidos para reduzir o tamanho da carga. 

“ConditionalParametersTrimmed” será retornado na resposta quando isso acontecer para informar ao cliente que as informações de  conditionalParameters  foram removidas.

“conditionalParametersTrimmed” é um objeto de matriz que contém as informações sobre as chaves que foram cortadas.

O truncamento será feito na seguinte ordem:

• includeSignedDocuments
• includeParticipantsInfo
• includeDocumentsInfo
• includeDetailedInfo

Os documentos assinados serão truncados primeiro, seguidos pelas informações do participante, informações do documento e, por fim, as informações detalhadas.

Isso pode acontecer, por exemplo, em um evento de conclusão de contrato, se este incluir um documento assinado (com codificação Base64), ou em um contrato com vários campos de formulário

Notificações do webhook

Os webhooks do Acrobat Sign enviam notificações ao remetente do contrato e todos os webhooks configurados no grupo do qual o contrato foi enviado. Os webhooks no escopo da conta recebem todos os eventos.

Tentar novamente quando o serviço de escuta estiver inativo

Se o URL de destino do webhook estiver inativo por algum motivo, o Acrobat Sign enfileira o JSON e tenta executar novamente o push em um ciclo progressivo ao longo de 72 horas.

Os eventos não entregues são persistidos em uma fila de tentativas e é feito um melhor esforço nas 72 horas seguintes para entregar as notificações na ordem em que ocorreram.

A estratégia para repetir a entrega de notificações é duplicar o tempo entre tentativas, começando com um intervalo de um minuto e aumentando para a cada 12 horas, resultando em 15 tentativas em 72 horas.

Se o receptor do webhook não responder dentro de 72 horas e não houver entregas de notificação bem-sucedidas nos últimos sete dias, o webhook será desativado. Nenhuma notificação será enviada para este URL até que o webhook seja ativado novamente.

Todas as notificações entre o momento em que o webhook é desativado e ativado novamente serão perdidas.