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.

Schritte

1. Melden Sie sich bei Test Manager als Administrator an.

2. Öffnen Sie Ihr Projekt.

3. Navigate to Project Settings > Integration.

4. Wählen Sie „Neue Verbindung“ aus und anschließend „WebHook“ in der Dropdownliste.

5. Konfigurieren Sie die folgenden Verbindungseinstellungen:

   • Name: Enter a name for your webhook connection.
   • Beschreibung (optional): Fügen Sie eine Beschreibung als Referenz hinzu.
   • 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. Wählen Sie Speichern.

7. Wählen Sie die Verbindung aus, erweitern Sie den Bereich und kopieren Sie den API-Schlüssel zur späteren Verwendung.

Ergebnis

Die Webhook-Verbindung wurde erstellt. Externe Tools können jetzt Test Manager-Ereignisse wie die Erstellung von Defekten und KPI-Aktualisierungen aus dem verbundenen Projekt abonnieren.

Editing a webhook connection

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

Schritte

1. Melden Sie sich beim Test Manager als Administrator an.
2. Öffnen Sie Ihr Projekt.
3. Go to Project Settings.
4. In the Integration list, select a webhook connection to expand the panel.
5. Wählen Sie „Bearbeiten“ aus, um die Verbindung zu konfigurieren.
6. Klicken Sie zum Bestätigen auf Speichern.

Ergebnis

The webhook connection settings are updated.

Deleting a webhook connection

Deleting a connection removes it together with its associated requirements.

Schritte

1. Melden Sie sich beim Test Manager als Administrator an.
2. Öffnen Sie Ihr Projekt.
3. Go to Project Settings.
4. In the Integration list, select a webhook connection to expand the panel.
5. Wählen Sie „Löschen“ aus, um die Verbindung zu entfernen.
6. Klicken Sie zum Bestätigen auf Ok .

Ergebnis

The webhook connection and its associated requirements are deleted.