Webhooks

O Test Manager fornece webhooks que permitem que ferramentas externas assinem eventos no Test Manager.

Atualmente, os seguintes eventos são suportados.

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

Contratos

Nesta seção, você pode encontrar os detalhes do payload de solicitação e resposta para cada evento.

Criar defeito.

O Test Manager dispara webhooks registrados com o seguinte 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.

KPIs de defeitos

O Test Manager dispara webhooks registrados com o seguinte 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
}

Configurar uma conexão de webhook

1. Faça login no Test Manager como Administrator

2. Abra seu projeto.

3. Navigate to Project Settings > Integration.

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

5. Defina as seguintes configurações de conexão:

   • Name: Enter a name for your WebHook connection.

   • Descrição (opcional): adicione uma descrição para referência.

   • 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. Clique em Salvar.

7. Clique na conexão para expandir o painel e copie a API Key para uso posterior.

Gerenciando conexões de WebHooks

A tabela a seguir lista as ações que você pode adotar para gerenciar suas conexões do WebHook.

Ação	Description	Procedimento
Editar	Edite suas configurações de conexão.	Efetue login no Test Manager como administrador. Abra seu projeto. Go to Project Settings. Na lista Integração, clique em uma conexão do WebHook para expandir o painel. Clique em Editar para configurar a conexão. Clique em Salvar para confirmar.
Excluir	Exclua a conexão selecionada e seus requisitos associados.	Efetue login no Test Manager como administrador. Abra seu projeto. Go to Project Settings. Na lista Integração, clique em uma conexão do WebHook para expandir o painel. Clique em Excluir para remover a conexão. Clique em Ok para confirmar.

Artigos relacionados

Sincronização de defeitos