Configurer et tester les webhooks

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 3 minutes de lecture
  • Configurez manuellement les webhooks et Azure DevOps testez-les.

    Configurer manuellement les webhooks Azure DevOps

    Configurez les webhooks dans Azure DevOps pour envoyer des notifications de synchronisation à l’application Changements de vélocité DevOps .

    Avant de commencer

    Rôle requis : sn_devops.admin ou sn_devops.tool_owner dans Changements de vélocité DevOps, Azure DevOps admin

    Pourquoi et quand exécuter cette tâche

    Vous pouvez également accéder à la configuration manuelle à partir de l’enregistrement de l’outil Azure DevOps dans Changements de vélocité DevOps.

    Procédure

    1. Dans Azure DevOps, ouvrez le projet pour lequel vous configurez des webhooks.
    2. Accédez à la Paramètres > Crochets de service et créez un NOUVEL ABONNEMENT AUX HOOK DE SERVICE, dans Azure DevOps.
    3. Dans Changements de vélocité DevOps, choisissez Configurer manuellement lors de la configuration de l’instance d’outil pour envoyer des données.
      Outil de configuration Azure DevOps
    4. Dans Changements de vélocité DevOps, copiez le champ URL Webhook à partir des détails de connexion de l’instance ServiceNow pour Azure DevOps.
      Remarque :
      Sélectionnez Copier dans le champ approprié pour copier la valeur dans votre presse-papiers. L’étiquette du champ bascule sur Copié, mais vous pouvez copier plusieurs fois.
      Azure DevOps : configurer manuellement les webhooks
    5. Modifiez l’URL Webhook copiée pour refléter les détails de votre outil, puis collez l’URL dans Azure DevOps.

      Par exemple :

      https://myinstance.service-now.com/api/sn_devops/v2/devops/tool/{code | plan | artifact | orchestration | test | softwarequality } ?toolId=23410545938c71d0db5bfe686cba1036&projectId=<project_sys_id>

      1. Sélectionnez l’une des fonctionnalités de l’outil {code | plan | artefact | orchestration | test | softwarequality } pour correspondre à votre outil.
        Par exemple :

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

      2. Remplacez <project_sys_id> par votre Azure DevOps ID de projet dans ServiceNow (native_id colonne de la table sn_devops_project).
      3. Copiez l’URL modifiée dans le champ URL de l’ABONNEMENT AUX NOUVEAUX HOOK DE SERVICE dans Azure DevOps.
    6. Dans Changements de vélocité DevOps, copiez le champ Jeton secret à partir des détails de connexion de l’instance ServiceNow pour Azure DevOps.
    7. Dans Azure DevOps, dans le champ En-tête de l’ABONNEMENT AUX NOUVEAUX HOOK DE SERVICE, collez le jeton secret copié au bon format.
      1. Utilisez ce format pour le champ Azure DevOps des en-têtes HTTP :
        « token : <tokenValue> »
      2. Remplacez <tokenValue> par le jeton secret copié à partir des détails de connexion de l’instance ServiceNow pour Azure DevOps.
      Tableau 1. Copier les valeurs de champ
      Champ De Changements de vélocité DevOps Champ À GitHub
      URL Webhook (modifiée) URL
      Jeton secret

      En-têtes HTTP

      Au format :

      jeton : <tokenValue>

      Azure DevOps : configurer manuellement les webhooks

    Tester les webhooks dans Azure DevOps

    Vous pouvez tester manuellement si les webhooks sont correctement configurés directement à partir de Azure DevOps pour chaque projet.

    Avant de commencer

    Rôle requis : Azure DevOps privilèges d’administrateur

    Procédure

    1. Accédez au Azure DevOps projet pour lequel vous souhaitez tester les webhooks et sélectionnez-le.
    2. Accédez à la Paramètres du projet > Crochets de service.
      Pour chaque projet, Changements de vélocité DevOps crée des webhooks pour les événements suivants :
      • Création terminée
      • Code transmis par push
      • Mise en production créée
      • Déploiement de la version terminé
      • État d’étape d’exécution modifié
      • Élément de travail créé
      • Élément de travail supprimé
      • Élément de travail restauré
      • Élément de travail mis à jour
    3. Sélectionnez un webhook, puis sélectionnez Modifier.
    4. Sélectionnez Suivant pour afficher les détails de l’URL et de l’authentification.

      Détails du webhook configuré.

    5. Pour tester le webhook, sélectionnez Tester.
      • Si le webhook est configuré correctement, vous recevrez un message Réussite .

        Message de réussite lorsque le webhook est configuré correctement.

      • Si le webhook n’est pas configuré correctement, vous recevez un message d’échec .

        Message d’échec lorsque le webhook est configuré correctement.

        Pour corriger un webhook, vous pouvez essayer les options suivantes :
        • Reconfigurez les webhooks en sélectionnant Configurer dans la page d’enregistrement de projet dans Changements de vélocité DevOps. Cela reconfigurera tous les webhooks existants pour le projet.
        • Vérifiez si les et projectId sont toolId corrects dans le champ URL. Vous pouvez trouver les valeurs correctes dans la page d’enregistrement de l’outil dans DevOps Change Velocity.

          toolId et projectId dans l’URL.

        • Si vous utilisez les informations d’identification de l’utilisateur d’intégration pour l’authentification, vérifiez si les informations d’identification sont correctes dans les champs nom d’utilisateur et mot de passe de l’authentification de base .

          Champs d’authentification de base dans le webhook.

        • Si vous utilisez le jeton secret pour l’authentification, la valeur du jeton est masquée dans le champ Mot de passe de l’authentification de base . Vous pouvez remplacer le jeton dans ce champ.

          Jeton dans le webhook.