Central de Atendimento
Home

Webhook

Antes de usar as funções neste manual do utilizador, é necessário compreender as restrições do Webhook correspondentes a diferentes versões:
  • Versão de avaliação: Não suporta a função Webhook
  • Versão básica: Não suporta a função Webhook
  • Versão profissional: Suporta a função Webhook

Webhook é um serviço de notificação de eventos assíncronos fornecido pela eSignGlobal, que permite aos utilizadores receber notificações de vários eventos que ocorrem no sistema através da configuração de um URL de retorno de chamada. Quando um evento especificado ocorre, o sistema envia um pedido HTTP POST para o URL configurado pelo utilizador, contendo informações detalhadas sobre o evento. Os utilizadores podem optar por subscrever eventos de diferentes fontes de acionamento, incluindo:

  • Iniciado na página SaaS: Eventos acionados por operações diretas do utilizador na plataforma SaaS.

  • Iniciado pela integração de um sistema de terceiros: Eventos de alteração de dados acionados por um sistema externo integrado através do APPID.

O Webhook enviará dados de eventos em tempo real para o endereço de retorno de chamada especificado, garantindo que obtém alterações de estado de negócios em tempo útil e implementa a integração de processos automatizados.

Adicionar Webhook

  1. O administrador pode clicar no botão [Adicionar Webhook] no menu [Definições - Webhook] para adicionar um Webhook.

    image.png

  2. Introduza as informações obrigatórias do Webhook e clique em Guardar.

Nota:

  • Nome do Webhook: Um nome fácil de identificar
  • URL de retorno de chamada: O endereço de retorno de chamada para receber notificações
  • Tipo de evento: Selecione os eventos que pretende subscrever
  • Fonte de acionamento: Pode optar por subscrever eventos de diferentes fontes de acionamento

image.png

  1. Para garantir que a fonte da mensagem Webhook é fiável, o sistema fornece um mecanismo de verificação de chave. Após guardar com sucesso, o sistema gera uma chave, por favor, guarde-a em segurança.

    image.png

Editar Webhook

  1. Na lista de gestão, encontre o Webhook que precisa de ajustar e clique no botão [Editar] para atualizar as suas definições.

Atenção:

  • Quando o estado está definido como desativado, pode editar o webhook.

image.png

Eliminar Webhook

  1. Na lista de gestão, encontre o Webhook que precisa de eliminar e clique no botão [Eliminar] para atualizar as suas definições.

Atenção:

  • Quando o estado está definido como desativado, pode eliminar o webhook.
  • A eliminação requer uma confirmação secundária, por favor, opere com cuidado.

image.png

Repor a Chave

  1. Na lista de gestão, encontre o Webhook que precisa de eliminar e clique no botão [Repor Chave] para gerar uma nova chave.

    image.png

  2. Após a chave ser gerada com sucesso, pode copiá-la.

    image.png

Ver Webhook

  1. Na lista de Webhooks, pode ver os detalhes do Webhook.

    image.png

    Link: