Webhooks

Test Manager provides webhooks that allow external tools to subscribe to events in Test Manager.

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.
• Defect KPIs: This event is invoked when the defect KPIs on the Test Manager dashboard are refreshed. This allows to include statistics from external defect management systems to be displayed on the Test Manager dashboard.

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:

Use the Test Manager REST API to fetch details about the failed test to add information to the created defect.

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 fires registered webhooks with the following payload:

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

1. Log in to Test Manager as an administrator.
2. Öffnen Sie Ihr Projekt.
3. Navigieren Sie zu Projekteinstellungen > Integration.
4. Klicken Sie auf Neue Verbindung und wählen Sie WebHook aus der Dropdownliste aus.
5. Konfigurieren Sie die folgenden Verbindungseinstellungen:
   • Name: Geben Sie einen Namen für Ihre WebHook-Verbindung ein.
   • Beschreibung (optional): Fügen Sie eine Beschreibung als Referenz hinzu.
   • Nutzlast-URL: Fügen Sie die Endpunktserver-URL hinzu. Beispiel: https://company-name-serverRegion.cloudapp.azure.com.
   • Authentifizierungsheadertyp: Wählen Sie eine Hashing-Methode zwischen Client Secret und HMACSHA256 aus.
   • Secret: Geben Sie den geheimen Wert Ihres Clients ein.
   • Unsicheres SSLzulassen : Wählen Sie aus, ob Endpunkte mit unsicheren SSL-Verbindungen zugelassen werden sollen.

   • Unterstützt Fehler-Dashboard: Wählen Sie aus, ob KPIs im Projekt-Dashboard angezeigt werden müssen.

     
     

     

     
     
6. Klicken Sie auf Speichern.
7. Klicken Sie auf die Verbindung, um das Panel zu erweitern und den API-Schlüssel zur späteren Verwendung zu kopieren.

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.	Log in to the Test Manager as an administrator. Öffnen Sie Ihr Projekt. Gehen Sie zu Projekteinstellungen. Klicken Sie in der Liste Integration auf eine WebHook-Verbindung, um den Bereich zu erweitern. Klicken Sie auf Bearbeiten , 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.	Log in to the Test Manager as an administrator. Öffnen Sie Ihr Projekt. Gehen Sie zu Projekteinstellungen. Klicken Sie in der Liste Integration auf eine WebHook-Verbindung, um den Bereich zu erweitern. Klicken Sie auf Löschen , um die Verbindung zu entfernen. Klicken Sie zum Bestätigen auf Ok.

Ähnliche Artikel

Synchronisierung von Defekten