Configurar o registro do webhook

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 2 min. de leitura

    • Configure um URL de retorno de chamada para comunicação entre as aplicações Gestão de assuntos jurídicos e Acompanhamento jurídico.

    Antes de Iniciar

    Função necessária: administrador, sn_lg_ops.legal_fulfiller

    Por Que e Quando Desempenhar Esta Tarefa

    A configuração do registro do webhook é necessária para sincronizar atualizações no registro de assunto externo na aplicação Gestão de assuntos jurídicos da aplicação Acompanhamento jurídico. Após a configuração bem-sucedida, o status de integridade da configuração deve ser Íntegro. Se o status for Quebrado, a sincronização das atualizações falhará.

    Procedimento

    1. Defina o escopo da aplicação como Gestão de assuntos jurídicos.
    2. Opcional: Se o escopo da aplicação não estiver definido corretamente, execute o seguinte:
      1. Selecione o ícone Escopo da aplicação ( ícone Escopo da aplicação).
      2. Selecione a opção Escopo da aplicação.
      3. No navegador de filtros, pesquise e selecione Gestão de assuntos jurídicos.
      4. Atualize a página.
    3. Navegar até Tudo > Definição do Sistema > Tabelas.
    4. Selecione Rótulo para o escopo de pesquisa e insira webhook.
    5. Selecione Registro do webhook do rastreador jurídico na lista.
    6. Selecione Mostrar formulário na seção Links relacionados.
    7. No campo Descrição, insira a descrição do webhook.
    8. No campo Token, preencha os detalhes.
      1. Selecione o ícone Pesquisar usando o ícone de lista Pesquisar usando o ícone de lista..
      2. Selecione Novo.
      3. Preencha os detalhes no formulário Novo registro de verificação de token.
        Tabela 1. Formulário Novo registro de verificação de token
        Campo Descrição
        Nome Nome do token.
        Descrição Descrição do token.
        Token Senha para acessar o token.
      4. Selecione Enviar.
    9. No campo Nome, insira o nome do webhook.
    10. Clique com o botão direito do mouse no cabeçalho da página e selecione Salvar.
    11. Selecione o URL de retorno de chamada.
      Na mensagem informativa que aparece, o URL de retorno de chamada é exibido. Copie este URL para usar no campo URL de retorno de chamada na plataforma Acompanhamento jurídico.
    12. Faça login na sua instância Acompanhamento jurídico e selecione o ícone de configurações ( ícone de configurações).
    13. Na seção Integrações, selecione Webhooks.
    14. Na seção Assuntos da página Webhooks, selecione Adicionar um novo webhook.
    15. No formulário, preencha os campos.
      Tabela 2. Criar formulário de webhook
      Campo Descrição
      URL do Retorno de Chamada As informações de URL de retorno de chamada copiadas da página de verificação de token.
      Eventos Eventos para os quais informações automatizadas estão disponíveis no assunto jurídico. As opções disponíveis são:

      A caixa de seleção Criar e atualizar deve ser marcada para receber as informações no assunto jurídico associado para qualquer nova modificação feita na plataforma Acompanhamento jurídico.
      Chave secreta Senha para acessar as informações do webhook.
    16. Selecione Salvar e fechar.

    Resultado

    O webhook da aplicação Acompanhamento jurídico foi configurado com sucesso e as atualizações de assuntos no Rastreador jurídico serão sincronizadas com a Gestão de assuntos jurídicos e os detalhes poderão ser vistos em registros de assuntos externos. Para uma configuração de webhook em funcionamento, o status de integridade deve ser Íntegro. Para qualquer configuração incorreta, o status de integridade é mostrado como Quebrado.