Configuring Webhook connection

Register, edit, or delete a webhook connection so external tools receive defect and KPI event payloads from your project.

A webhook connection sends event payloads, such as defect creation and key performance indicator (KPI) updates, from a project to an external tool.

Registering a webhook connection

Register a webhook connection in Project Settings > Integration as an administrator. The connection gives you an API Key to copy for later use.

Étapes

1. Connectez-vous à Test Manager en tant qu'administrateur.

2. Ouvrez votre projet.

3. Navigate to Project Settings > Integration.

4. Sélectionnez Nouvelle connexion et sélectionnez WebHook dans le menu déroulant.

5. Configurez les paramètres de connexion au service suivants :

   • Name: Enter a name for your webhook connection.
   • Description (facultatif) : ajoutez une description pour référence.
   • Payload URL: Add the endpoint server URL. For example: https://company-name-serverRegion.cloudapp.azure.com.
   • Authentication Header Type: Select a hashing method between Client Secret and HMACSHA256.
   • Secret: Enter your client secret value.
   • Allow Insecure SSL: Choose whether to allow endpoints with insecure SSL connections.
   • Supports Defect Dashboard: Choose if KPIs need to be shown in the project dashboard.

   

6. Sélectionnez Enregistrer.

7. Sélectionnez la connexion pour développer le panneau et copier la clé API pour une utilisation ultérieure.

Résultat

La connexion Webhook est créée. Les outils externes peuvent désormais s'abonner aux événements de Test Manager tels que la création de défauts et les mises à jour des KPI du projet connecté.

Editing a webhook connection

Editing a connection changes the settings of an existing webhook connection.

Étapes

1. Connectez-vous à Test Manager en tant qu'administrateur.
2. Ouvrez votre projet.
3. Go to Project Settings.
4. In the Integration list, select a webhook connection to expand the panel.
5. Sélectionnez Modifier pour configurer la connexion.
6. Cliquez sur Enregistrer pour confirmer.

Résultat

The webhook connection settings are updated.

Deleting a webhook connection

Deleting a connection removes it together with its associated requirements.

Étapes

1. Connectez-vous à Test Manager en tant qu'administrateur.
2. Ouvrez votre projet.
3. Go to Project Settings.
4. In the Integration list, select a webhook connection to expand the panel.
5. Sélectionnez Supprimer pour supprimer la connexion.
6. Sélectionnez OK pour confirmer.

Résultat

The webhook connection and its associated requirements are deleted.