Webhooks

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 chama a tarefa "Criar Defeito" a partir de um resultado de caso de teste. Ele permite que ferramentas externas de gerenciamento de defeitos recebam relatórios de defeitos com informações de log dos resultados dos 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 buscar detalhes sobre o teste com falha para incluir informações no 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

1. Faça login no Test Manager como administrador.
2. Abra seu projeto.
3. Navegue até Configurações do projeto > Integração.
4. Clique em Nova conexão e selecione WebHook na lista suspensa.
5. Defina as seguintes configurações de conexão:
   • Nome: insira um nome para sua conexão do WebHook.
   • Descrição (opcional): adicione uma descrição para referência.
   • URL da carga útil: adicione a URL do servidor do ponto de extremidade. Por exemplo: https://company-name-serverRegion.cloudapp.azure.com.
   • Tipo de Cabeçalho de Autenticação: Selecione um método de hash entre Client Secret e HMACSHA256.
   • Segredo: insira o valor do segredo do cliente.
   • Permitir SSL inseguro: escolha se deseja permitir terminais com conexões SSL inseguras.

   • Suporta Painel de Defeitos: Escolha se os KPIs precisam ser exibidos no painel do projeto.

     
     

     

     
     
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.	Faça login no Test Manager como administrador. Abra seu projeto. Vá para Configurações do projeto. 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.	Faça login no Test Manager como administrador. Abra seu projeto. Vá para Configurações do projeto. 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