Configuring Webhook connection

Register, edit, or delete a webhook connection so external tools receive defect and KPI event payloads from your project.

A webhook connection sends event payloads, such as defect creation and key performance indicator (KPI) updates, from a project to an external tool.

Registering a webhook connection

Register a webhook connection in Project Settings > Integration as an administrator. The connection gives you an API Key to copy for later use.

Etapas

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

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.

Editing a webhook connection

Editing a connection changes the settings of an existing webhook connection.

Etapas

1. Efetue login no Test Manager como administrador.
2. Abra seu projeto.
3. Go to Project Settings.
4. In the Integration list, select a webhook connection to expand the panel.
5. Selecione Editar para configurar a conexão.
6. Selecione Salvar para confirmar.

Resultado

The webhook connection settings are updated.

Deleting a webhook connection

Deleting a connection removes it together with its associated requirements.

Etapas

1. Efetue login no Test Manager como administrador.
2. Abra seu projeto.
3. Go to Project Settings.
4. In the Integration list, select a webhook connection to expand the panel.
5. Selecione Excluir para remover a conexão.
6. Selecione Ok para confirmar.

Resultado

The webhook connection and its associated requirements are deleted.