Webhooks

Webhooks im Test Manager zur Benachrichtigung externer Tools über Ereignisse wie die Erstellung von Fehlern.

Test Manager stellt Webhooks bereit, mit denen externe Tools Ereignisse in Test Manager abonnieren können.

Derzeit werden die folgenden Ereignisse unterstützt.

• Defekt erstellen: Dieses Ereignis wird ausgelöst, wenn ein Benutzer die Aufgabe „Defekt erstellen“ von einem Testfallergebnis aus aufruft. Sie ermöglicht es externen Defektverwaltungstools, Defektberichte mit Protokollinformationen aus Testergebnissen zu erhalten.
• Defekte KPIs: Dieses Ereignis wird aufgerufen, wenn die defekten KPIs im Test Manager-Dashboard aktualisiert werden. Dadurch können Statistiken aus externen Fehlermanagementsystemen eingeschlossen werden, die auf dem Test Manager-Dashboard angezeigt werden.

Verträge

In diesem Abschnitt finden Sie die Details der Anforderungs- und Antwortnutzlast für jedes Ereignis.

Erstellen Sie einen Fehler.

Test Manager feuert registrierte Webhooks mit der folgenden Nutzlast aus:

Verwenden Sie die Test Manager REST-API, um Details zum fehlgeschlagenen Test abzurufen und Informationen zum erstellten Defekt hinzuzufügen.

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.

Fehler-KPIs

Test Manager feuert registrierte Webhooks mit der folgenden Nutzlast aus:

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
}

Konfigurieren einer Webhook-Verbindung

Registrieren Sie einen Webhook-Endpunkt in Test Manager, damit externe Tools Ereignis-Payloads – beispielsweise zur Erstellung von Defekten oder zu KPI-Aktualisierungen – aus Ihrem Projekt empfangen können.

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 needs 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.

Verwalten von WebHooks-Verbindungen

In der folgenden Tabelle sind die Aktionen aufgeführt, die Sie zum Verwalten Ihrer WebHooks-Verbindungen ausführen können.

Aktion	Beschreibung	Verfahren
Bearbeiten	Bearbeiten Sie Ihre Verbindungseinstellungen.	Melden Sie sich beim Test Manager als Administrator an. Öffnen Sie Ihr Projekt. Gehen Sie zu Projekteinstellungen . Wählen Sie in der Liste „Integration“ eine WebHook-Verbindung aus, um den Bereich zu erweitern. Wählen Sie „Bearbeiten“ aus, um die Verbindung zu konfigurieren. Klicken Sie zum Bestätigen auf Speichern.
Löschen	Löschen Sie die ausgewählte Verbindung und die zugehörigen Anforderungen.	Melden Sie sich beim Test Manager als Administrator an. Öffnen Sie Ihr Projekt. Gehen Sie zu Projekteinstellungen . Wählen Sie in der Liste „Integration“ eine WebHook-Verbindung aus, um den Bereich zu erweitern. Wählen Sie „Löschen“ aus, um die Verbindung zu entfernen. Klicken Sie zum Bestätigen auf Ok .

Ähnliche Artikel

Synchronisierung von Defekten

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.