Webhooks

Test Manager provides webhooks that allow external tools to subscribe to events in Test Manager.

Currently, the following events are supported.

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.

Contracts

In this section you can find the request and response payload details for each event.

Create Defect.

Test Manager fires registered webhooks with the following payload:

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

Defect KPIs

Test Manager fires registered webhooks with the following payload:

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
}

Configure a Webhook Connection

Log in to Test Manager as an administrator.
Open your project.
Navigate to Project Settings > Integration.
Click New Connection and select WebHook from the dropdown.
Configure the following connection settings:
- Name: Enter a name for your WebHook connection.
- Description (Optional): Add a description for reference.
- 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.
Click Save.
Click the connection to expand the panel and copy the API Key for later use.

Managing WebHooks connections

The following table lists the actions that you can take to manage your WebHooks connections.

Action	Description	Procedure
Edit	Edit your connection settings.	Log in to the Test Manager as an administrator. Open your project. Go to Project Settings. In the Integration list, click a WebHook connection to expand the panel. Click Edit to configure the connection. Click Save to confirm.
Delete	Delete the selected connection and its associated requirements.	Log in to the Test Manager as an administrator. Open your project. Go to Project Settings. In the Integration list, click a WebHook connection to expand the panel. Click Delete to remove the connection. Click Ok to confirm.