Webhooks

Test Manager 提供了 Webhook，允许外部工具订阅 Test Manager 中的事件。

目前，支持以下事件。

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

合同

在本节中，您可以找到每个事件的请求和响应有效负载详细信息。

创建缺陷。

Test Manager 使用以下有效负载触发已注册的 Webhook：

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.

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

配置 Webhook 连接

1. 以管理员身份登录 Test Manager。

2. 打开项目。

3. Navigate to Project Settings > Integration.

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

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 needs to be shown in the project dashboard.

     

6. 单击“保存”。

7. 单击连接以展开面板并复制 API 密钥以备后用。

管理 WebHook 连接

下表列出了可以用来管理 WebHooks 连接的操作。

操作	描述	程序
编辑	编辑连接设置。	以管理员身份登录 Test Manager。 打开项目。 Go to Project Settings. 在“集成”列表中，单击 WebHook 连接以展开面板。 单击“编辑”以配置连接。 单击“保存”以确认。
删除	删除选定的连接及其关联的要求。	以管理员身份登录 Test Manager。 打开项目。 Go to Project Settings. 在“集成”列表中，单击 WebHook 连接以展开面板。 单击“删除”以删除连接。 单击“确定”以确认。

相关文章

缺陷同步