Webhooks

Test Manager fournit des webhooks permettant aux outils externes de s’abonner à des événements dans Test Manager.

Actuellement, les événements suivants sont pris en charge.

Créer un défaut (Create Defect) : cet événement est déclenché chaque fois qu’un utilisateur invoque la tâche « Créer un défaut » à partir d'un résultat de cas de test. Il permet aux outils externes de gestion des défauts de recevoir des rapports de défauts avec des informations de journal à partir des résultats de test.
KPI de défaut : cet événement est invoqué lorsque les KPI de défaut sur le tableau de bord de Test Manager sont actualisés. Cela permet d’inclure des statistiques des systèmes de gestion des défauts externes à afficher sur le tableau de bord de Test Manager.

Contrats

Dans cette section, vous pouvez trouver les détails de la charge utile de la demande et de la réponse pour chaque événement.

Créer un défaut

Test Manager déclenche des webhooks enregistrés avec la charge utile suivante :

Utilisez l’API REST de Test Manager pour récupérer les détails du test qui a échoué afin d’ajouter des informations au défaut créé.

Request:
CreateDefectFromTestCaseLogRequest{
testExecutionId    string($uuid)
testCaseId    string($uuid)
variationId    string
nullable: true
linkToTestCaseLog    string
nullable: true
}
Response:
Returns a defect payload to allow Test Manager to add a link to the created defect in the test case log.Request:
CreateDefectFromTestCaseLogRequest{
testExecutionId    string($uuid)
testCaseId    string($uuid)
variationId    string
nullable: true
linkToTestCaseLog    string
nullable: true
}
Response:
Returns a defect payload to allow Test Manager to add a link to the created defect in the test case log.

ICP défectueux

Test Manager déclenche des webhooks enregistrés via la charge utile suivante :

Request:
api/kpis/project/<projectid>/defectstatus
Response:
KPIConnectorDefectsDto{
totalDefects    integer($int32)
criticalDefects    integer($int32)
moderateDefects    integer($int32)
openDefects    integer($int32)
closedDefects    integer($int32)
status    ConnectorKPIStatusstring
Enum:
Array [ 3 ]
criticalDefectsLink    string
nullable: true
}Request:
api/kpis/project/<projectid>/defectstatus
Response:
KPIConnectorDefectsDto{
totalDefects    integer($int32)
criticalDefects    integer($int32)
moderateDefects    integer($int32)
openDefects    integer($int32)
closedDefects    integer($int32)
status    ConnectorKPIStatusstring
Enum:
Array [ 3 ]
criticalDefectsLink    string
nullable: true
}

Configurer une connexion de webhook

Connectez-vous à Test Manager en tant qu’administrateur.
Ouvrez votre projet.
Accédez à Paramètres du projet (Project Settings) > Intégration(Integration).
Cliquez sur Nouvelle connexion et sélectionnez WebHook dans la liste déroulante.
Configurez les paramètres de connexion au service suivants :
- Nom: saisissez un nom pour votre connexion WebHook.
- Description (facultatif) : ajoutez une description pour référence.
- URL du serveur : ajoutez l'URL du serveur de point de terminaison. Par exemple : https://company-name-serverRegion.cloudapp.azure.com.
- Type d'en-tête d'authentification: sélectionnez une méthode de hachage comprise entre Client Secret et HMACSHA256 .
- Clé secrète: saisissez la valeur de votre clé secrète client.
- Autoriser le SSLnon sécurisé : choisissez si vous souhaitez autoriser les points de terminaison avec des connexions SSL non sécurisées.
- Prise en charge du tableau de bord des défauts: choisissez si les ICP doivent être affichés dans le tableau de bord du projet.
Cliquez sur Enregistrer (Save).
Cliquez sur la connexion pour développer le panneau et copier la clé API pour une utilisation ultérieure.

Gestion des connexions WebHooks

Le table suivante répertorie les actions que vous pouvez effectuer pour gérer vos applications.

Action	Description	Procédure
Modifier (Edit)	Modifiez vos paramètres de connexion.	Connectez-vous à Test Manager en tant qu’administrateur. Ouvrez votre projet. Accédez à Paramètres du projet. Dans la liste Intégration, cliquez sur une connexion WebHook pour développer le panneau. Cliquez sur Modifier ( Edit) pour configurer la connexion. Cliquez sur Enregistrer (Save) pour confirmer.
Supprimer (Delete)	Supprime la connexion sélectionnée et ses exigences associées.	Connectez-vous à Test Manager en tant qu’administrateur. Ouvrez votre projet. Accédez à Paramètres du projet. Dans la liste Intégration, cliquez sur une connexion WebHook pour développer le panneau. Cliquez sur Supprimer ( Delete) pour supprimer la connexion. Cliquez sur OK pour confirmer.