test-suite
2021.10
false
- Getting Started with Test Suite
- Studio
- Orchestrator
- Testing robots
- Test Manager
Webhooks
![](https://docs.uipath.com/_next/static/media/grid.05ebd128.png?w=3840&%3Bq=100)
Test Suite User Guide
Last updated Aug 13, 2024
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.
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.
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
}
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. |
|
Delete |
Delete the selected connection and its associated requirements. |
|
Related articles