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. Navigate to Project Settings > Integration.

4. 选择 New Connection（新建连接），然后从下拉列表中选择 Webhook。

5. 配置以下连接设置:

   • Name: Enter a name for your webhook connection.
   • 说明（可选）: 添加说明以供参考。
   • 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 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. Go to Project Settings.
4. In the Integration list, select a webhook connection to expand the panel.
5. 选择 Edit（编辑）以配置连接。
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. Go to Project Settings.
4. In the Integration list, select a webhook connection to expand the panel.
5. 选择 Delete（删除）以移除连接。
6. 选择“确定”以确认。

结果

The webhook connection and its associated requirements are deleted.