Configurer un webhook

En plus des intégrations permettant de synchroniser vos dépôts (repositories) depuis Azure DevOps,  GitLab ou GitHub, Axify vous permet de générer des webhooks. Cette configuration vise à synchroniser les données relatives au déploiement de votre code vers Axify pour plus de précision et alimente les métriques DORA.

Il est possible de générer et lier plus d’un webhook à un même projet Axify, de le renommer, ou même de le révoquer au besoin.

 

Pour générer un webhook depuis Axify

1. Accédez au projet concerné, puis aux Paramètres de projet.
   
   
2. Sélectionnez l’onglet Intégrations. C’est ici que vous retrouverez les intégrations actuellement actives et liées à ce projet.
   
   

   

3. Dans la section Axe Technique située au bas de la page, sous Déploiement, cliquez sur Générer un webhook.
   
   

   

4. Un menu s’affichera. Sélectionnez le webhook à générer.
   

   
   
   

5. L’URL (endpoint) et le jeton secret nécessaires à la configuration du webhook seront automatiquement générés par Axify. Vous pouvez maintenant copier ces informations en cliquant sur à la droite de la donnée requise et poursuivre la configuration dans le logiciel concerné.
   
   
6. Une fois la configuration complétée, assurez-vous de bien Configurer vos environnements de déploiement afin de permettre l'importation de vos données.

Pour plus d’informations sur la configuration propre à certains logiciels, nous vous invitons à consulter les ressources suivantes.

• Documentation officielle de GitLab
  • Essentiellement, les events de type déploiement doivent être envoyés au webhook pour assurer la connexion. Cela signifie donc que, lors de la configuration dans GitLab, vous devez :
    • Cocher Deployment Events. 
    • Cocher l’option SSL.
    • Décocher l’option Push.
  • Pour la partie CI, vous devez utiliser le flow de déploiement de GitLab pour qu’Axify puisse suivre les évènements de déploiement. Vous pouvez vous référer à cette documentation officielle pour de plus amples détails.
  • En date du 19 avril 2022, seuls les déploiements effectués en environnement de production sont comptabilisés.
    
    
• Documentation officielle de GitHub
  • Comme pour GitLab, les events de type déploiement de GitHub doivent être envoyés au webhook. Lors de la configuration dans GitHub, vous devez :
    • Activer les évènements de type JSON (seuls évènements supportés en date du 28 avril 2022)
    • Activer la vérification SSL.
    • Sous « Which events would you like to trigger this webhook », sélectionnez uniquement les évènements de type Deployment statuses.
    • Cocher la case Active au bas de la page de configuration.
    • Cliquer sur Add webhook.
  • Il est à noter que, dans la documentation de GitHub sur la configuration des webhooks, il est mentionné au bas de la page qu’un évènement ping est envoyé automatiquement à la création. En date du 28 avril 2022, ce ping échoue automatiquement, mais l’évènement de déploiement fonctionne. Cette fonctionnalité sera supportée dans une prochaine version.
    
    
• Documentation officielle de Microsoft
  • La configuration du webhook pour Azure DevOps comporte quelques particularités. Pour débuter, accédez au projet désiré dans Azure DevOps.
  • Au coin inférieur gauche, cliquez sur Project Settings, puis sur Service Hooks dans le menu de gauche de la fenêtre qui s'ouvrira.
  • S'il n'y a pas déjà de webhook généré, cliquez sur le bouton bleu Create subscription. Si vous avez déjà des webhooks, cliquez sur le + vert situé au haut de la liste.
  • Dans le menu qui s'affiche, sélectionnez l'option web hooks (au bas de la liste), puis cliquez sur suivant.
  • Dans le menu Trigger on this type of event, sélectionnez le type Release deployment completed.
    • Si désiré, vous pouvez préciser le nom du pipeline. Généralement, le plus haut niveau de détail est préféré.
  • Au niveau du status, sélectionnez Succeded, puis cliquez sur Suivant.
  • Dans la section Settings, sous URL, collez l'URL généré et copié depuis Axify.
    
    
    
    • Les champs basic authentification (username et password) sont facultatifs, donc peuvent être laissés vides.
  • Dans le champ HTTP headers, inscrivez X-Azure-Token: , puis collez le secret token généré depuis Axify. L'espace après les : est facultatif.
    
  • Dans le champ Messages to send, sélectionnez l'option None. Faites la même sélection pour le champ Detailed messages to send.
  • Dans le champ Resource version, sélectionnez l'option 3.0 preview 1.
  • Cliquez sur Terminer.

Pour renommer un webhook

1. Suivez les étapes précédentes pour accéder aux intégrations.
2. Sous la section Déploiement, repérez le webhook à renommer.
3. Cliquez sur  à la droite du nom actuel du webhook concerné.
4. Modifiez le nom du webhook.
   1. Pour enregistrer votre modification, cliquez sur .
   2. Pour annuler votre modification, cliquez sur .

Pour révoquer un webhook

1. Suivez les étapes précédentes pour accéder aux intégrations.
2. Sous la section Déploiement, repérez le webhook à révoquer.
3. Cliquez sur Révoquer à la droite de la ligne d’options pour le webhook concerné.
4. Une fenêtre de confirmation s’affichera. Pour confirmer la révocation du webhook, cliquez sur Oui, révoquer.

Attention : Cette action est irréversible.