Webhooks

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

Derzeit werden die folgenden Ereignisse unterstützt.

• Create Defect: This event is triggered whenever a user invokes the "Create Defect" task from a test case result. It allows external defect management tools to receive defect reports with log information from test results.
• 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 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

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

2. Öffnen Sie Ihr Projekt.

3. Navigate to Project Settings > Integration.

4. Click New Connection and select WebHook from the dropdown.

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. Klicken Sie auf Speichern (Save).

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.	Melden Sie sich beim Test Manager als Administrator an. Öffnen Sie Ihr Projekt. Go to Project Settings. 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.	Melden Sie sich beim Test Manager als Administrator an. Öffnen Sie Ihr Projekt. Go to Project Settings. 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