Configurar e testar webhooks

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 3 min. de leitura

    • Configure manualmente os webhooks em Azure DevOps e teste-os.

    Configurar webhooks em Azure DevOps manualmente

    Configure webhooks em Azure DevOps para enviar notificações de sincronização para a aplicação Velocidade de mudança para DevOps.

    Antes de Iniciar

    Função necessária: sn_devops.admin ou sn_devops.tool_owner em Velocidade de mudança para DevOps, Azure DevOps admin

    Por Que e Quando Desempenhar Esta Tarefa

    Você também pode acessar a configuração manual no registro da ferramenta [ Azure DevOps em Velocidade de mudança para DevOps.

    Procedimento

    1. Em Azure DevOps, abra o projeto para o qual você está configurando webhooks.
    2. Navegar até Configurações > Ganchos de serviço e crie uma NOVA ASSINATURA DE GANCHOS DE SERVIÇO, em Azure DevOps.
    3. Em Velocidade de mudança para DevOps, escolha Configurar manualmente ao configurar a instância da ferramenta para enviar dados.
      Ferramenta de configuração do Azure DevOps
    4. Em Velocidade de mudança para DevOps, copie o campo URL do Webhook dos detalhes de conexão da instância da ServiceNow para Azure DevOps.
      Nota:
      Selecione Copiar no campo apropriado para copiar o valor para a área de transferência. O rótulo do campo muda para Copiado, mas você pode copiar várias vezes.
      Azure DevOps configurar webhooks manualmente
    5. Modifique a URL do Webhook copiada para refletir os detalhes da ferramenta e cole a URL em Azure DevOps.

      Por exemplo:

      https://myinstance.service-now.com/api/sn_devops/v2/devops/tool/{code | plano | artefato | orquestração | teste | softwarequality }?toolId=23410545938c71d0db5bfe686cba1036&projectId=<project_sys_id>

      1. Selecione uma das capacidades da ferramenta {code | plano | artefato | orquestração | teste | softwarequality } para corresponder à sua ferramenta.
        Por exemplo:

        https://myinstance.service-now.com/api/sn_devops/v2/devops/tool/orchestration?toolId=23410545938c71d0db5bfe686cba1036&projectId=<project_sys_id>

      2. Substituir<project_sys_id> com seu Azure DevOps ID de projeto em ServiceNow (coluna native_id na tabela sn_devops_project).
      3. Copie a URL modificada para o campo URL da NOVA ASSINATURA DE HOOKS DE SERVIÇO em Azure DevOps.
    6. Em Velocidade de mudança para DevOps, copie o campo Token secreto dos detalhes de conexão da instância da ServiceNow para o Azure DevOps.
    7. Em Azure DevOps, no campo Cabeçalho da ASSINATURA DE NOVAS ASSINATURAS DE GANCHOS DE SERVIÇO, cole o Token secreto copiado no formato correto.
      1. Use este formato para o campo de Azure DevOps cabeçalhos HTTP :
        "token:<tokenValue> "
      2. Substituir<tokenValue> , com o Token secreto copiado dos detalhes de conexão da instância da ServiceNow para Azure DevOps .
      Tabela 1. Copiar valores de campo
      Do campo Velocidade de mudança para DevOps Para o campo GitHub
      URL do Webhook (modificado) URL
      Token secreto

      Cabeçalhos HTTP

      No formato:

      token:<tokenValue>
      Azure DevOps configurar webhooks manualmente

    Testar webhooks no Azure DevOps

    Você pode testar manualmente se os webhooks estão configurados corretamente diretamente de Azure DevOps para cada projeto.

    Antes de Iniciar

    Função necessária: Azure DevOps privilégios de administrador

    Procedimento

    1. Navegue até Azure DevOps e selecione o projeto para o qual você deseja testar webhooks.
    2. Navegar até Configurações do projeto > Ganchos de serviço.
      Para cada projeto, Velocidade de mudança para DevOps cria webhooks para estes eventos:
      • Compilação concluída
      • Código enviado
      • Versão criada
      • Implantação da versão concluída
      • Estado da fase de execução alterado
      • Item de trabalho criado
      • Item de trabalho excluído
      • Item de trabalho restaurado
      • Item de trabalho atualizado
    3. Selecione um webhook e clique em Editar.
    4. Selecione Avançar para ver o URL e os detalhes de autenticação.

      Detalhes do webhook configurado.

    5. Para testar o webhook, selecione Testar.

      • Se o webhook estiver configurado corretamente, você receberá uma mensagem de sucesso.

        Mensagem de sucesso quando o webhook está configurado corretamente.

      • Se o webhook estiver configurado incorretamente, você receberá uma mensagem de falha.

        Mensagem de falha quando o webhook está configurado corretamente.

        Para corrigir um webhook, você pode tentar as seguintes opções:
        • Reconfigure os webhooks selecionando Configurar na página de registro do projeto em Velocidade de mudança para DevOps. Isso reconfigurará todos os webhooks existentes para o projeto.

        • Verifique se toolId e projectId estão corretos no campo URL. Você pode encontrar os valores corretos na página de registro da ferramenta no Velocidade de mudança para DevOps.

          toolId e projectId no URL.

        • Se você estiver usando as credenciais do usuário de integração para autenticação, verifique se as credenciais estão corretas nos campos de nome de usuário e senha da Autenticação básica.

          Campos de autenticação básica no webhook.

        • Se você estiver usando o token secreto para autenticação, o valor do token será mascarado no campo Senha da autenticação básica. Você pode substituir o token neste campo.

          Token no webhook.