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.

手順

1. Test Manager に管理者としてログインします。

2. プロジェクトを開きます。

3. [プロジェクト設定] > [連携] に移動します。

4. [新しい接続] を選択して、ドロップダウンから [Webhook] を選択します。

5. 次の接続設定を構成します。

   • Name: Enter a name for your webhook connection.
   • 説明 (任意): 参考になる説明を入力します。
   • ペイロード URL: エンドポイント サーバーの URL を追加します。例: https://company-name-serverRegion.cloudapp.azure.com。
   • 認証ヘッダーの種類: Client Secret および HMACSHA256 のいずれかのハッシュ方法を選択します。
   • シークレット: クライアント シークレットの値を入力します。
   • セキュリティで保護されていない SSL を許可: セキュリティで保護されていない SSL 接続を使用するエンドポイントを許可するかどうかを選択します。
   • Supports Defect Dashboard: Choose if KPIs need to be shown in the project dashboard.

   

6. [保存] を選択します。

7. 接続を選択してパネルを展開し、後で必要になる [API キー] をコピーします。

結果

Webhook 接続が作成されます。外部ツールが、接続されているプロジェクトから Test Manager のイベント (不具合の作成や KPI の更新など) にサブスクライブできるようになります。

Editing a webhook connection

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

手順

1. Test Manager に管理者としてログインします。
2. プロジェクトを開きます。
3. [プロジェクト設定] に移動します。
4. In the Integration list, select a webhook connection to expand the panel.
5. [編集] を選択して接続を設定します。
6. [保存] を選択して確定します。

結果

The webhook connection settings are updated.

Deleting a webhook connection

Deleting a connection removes it together with its associated requirements.

手順

1. Test Manager に管理者としてログインします。
2. プロジェクトを開きます。
3. [プロジェクト設定] に移動します。
4. In the Integration list, select a webhook connection to expand the panel.
5. [削除] を選択して、接続を削除します。
6. [OK] を選択して確定します。

結果

The webhook connection and its associated requirements are deleted.