Webhooks

Webhooks no Test Manager para notificar ferramentas externas sobre eventos, como criação de defeitos.

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

Atualmente, os seguintes eventos são suportados.

• Criar Defeito: este evento é acionado sempre que um usuário invoca a tarefa "Criar Defeito" a partir de um resultado de caso de teste. Permite que ferramentas de gerenciamento de defeitos externas recebam relatórios de defeitos com informações de log de resultados de testes.
• KPIs de defeitos: esse evento é invocado quando os KPIs de defeitos no painel Test Manager forem atualizados. Isso permite incluir estatísticas de sistemas de gerenciamento de defeitos externos, a serem exibidas no painel Test Manager.

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 a API REST do Test Manager para obter detalhes sobre o teste com falha para adicionar informações ao defeito criado.

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

Registre um ponto de extremidade do webhook no Test Manager, para que as ferramentas externas recebam cargas de eventos (como criação de defeitos ou atualizações de KPIs) de seu projeto.

1. Faça login no Test Manager como Administrator

2. Abra seu projeto.

3. Navigate to Project Settings > Integration.

4. Selecione Nova conexão e selecione Webhook no menu suspenso.

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

7. Selecione a conexão para expandir o painel e copie a Chave de API 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. Acesse Configurações do projeto . Na lista Integração, selecione uma conexão do webhook para expandir o painel. Selecione Editar para configurar a conexão. Selecione Salvar para confirmar.
Excluir	Exclua a conexão selecionada e seus requisitos associados.	Efetue login no Test Manager como administrador. Abra seu projeto. Acesse Configurações do projeto . Na lista Integração, selecione uma conexão do webhook para expandir o painel. Selecione Excluir para remover a conexão. Selecione Ok para confirmar.

Artigos relacionados

Sincronização de defeitos

Resultado

A conexão do webhook foi criada. As ferramentas externas agora podem se inscrever em eventos do Test Manager, como criação de defeitos e atualizações de KPIs do projeto conectado.