Webhook

Test Manager には、外部ツールが Test Manager 内のイベントにサブスクライブするための Webhook が用意されています。

現在、次のイベントがサポートされています。

不具合を作成: このイベントは、テストケースの結果から [不具合を作成] タスクを呼び出すと常にトリガーされます。外部の不具合管理ツールで、テスト結果からのログ情報を含む不具合レポートを受信できるようになります。
不具合の KPI: このイベントは、Test Manager ダッシュボードで不具合の KPI が更新されると呼び出されます。外部の不具合管理システムからの統計情報を Test Manager ダッシュボードに表示できるようになります。

Contracts (コントラクト)

このセクションでは、各イベントの要求および応答ペイロードの詳細を示します。

不具合を作成する

Test Manager は、以下のペイロードで登録済みの Webhook を起動します。

Test Manager REST API を使用して、不合格だったテストの詳細を取得し、作成した不具合に情報を追加します。

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

不具合の KPI

Test Manager は、以下のペイロードで登録済みの Webhook を起動します。

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
}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
}

Webhook 接続を設定する

Test Manager に管理者としてログインします。
プロジェクトを開きます。
[プロジェクト設定] > [連携] に移動します。
[新しい接続] をクリックして、ドロップダウンから [Webhook] を選択します。
次の接続設定を構成します。
- 名前: Webhook 接続の名前を入力します。
- 説明 (任意): 参考になる説明を入力します。
- ペイロード URL: エンドポイントサーバーの URL を追加します。例: https://company-name-serverRegion.cloudapp.azure.com
- 認証ヘッダーの種類: Client Secret および HMACSHA256 のいずれかのハッシュ方法を選択します。
- シークレット: クライアントシークレットの値を入力します。
- セキュリティで保護されていない SSL を許可: セキュリティで保護されていない SSL 接続を使用するエンドポイントを許可するかどうかを選択します。
- 不具合のダッシュボードをサポート: プロジェクトダッシュボードに KPI を表示する必要があるかどうかを選択します。
[保存] をクリックします。
接続をクリックしてパネルを展開し、後で必要になる [API キー] をコピーします。

Webhook 接続を管理する

以下に、Webhook 接続を管理するために実行できるアクションのリストを示します。

操作	説明	手順
編集	接続設定を編集します。	Test Manager に管理者としてログインします。プロジェクトを開きます。 [プロジェクト設定] に移動します。連携のリストで Webhook 接続をクリックし、パネルを展開します。 [編集] をクリックして接続を設定します。 [保存] をクリックして確定します。
削除する	選択した接続および関連する要件を削除します。	Test Manager に管理者としてログインします。プロジェクトを開きます。 [プロジェクト設定] に移動します。連携のリストで Webhook 接続をクリックし、パネルを展開します。 [削除] をクリックして、接続を削除します。 [OK] をクリックして確定します。