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.

Pasos

1. Inicia sesión en Test Manager como administrador.

2. Abra su proyecto.

3. Navigate to Project Settings > Integration.

4. Selecciona Nueva conexión y selecciona Webhook de la lista desplegable.

5. Configura los siguientes ajustes de conexión:

   • Name: Enter a name for your webhook connection.
   • Descripción (opcional): añade una descripción como referencia.
   • 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. Selecciona Guardar.

7. Selecciona la conexión para expandir el panel y copiar la Clave API para su uso posterior.

Resultado

Se crea la conexión de webhook. Las herramientas externas ahora pueden suscribirse a eventos de Test Manager como la creación de defectos y las actualizaciones de KPI del proyecto conectado.

Editing a webhook connection

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

Pasos

1. Inicia sesión en Test Manager como administrador.
2. Abra su proyecto.
3. Go to Project Settings.
4. In the Integration list, select a webhook connection to expand the panel.
5. Selecciona Editar para configurar la conexión.
6. Selecciona Guardar para confirmar.

Resultado

The webhook connection settings are updated.

Deleting a webhook connection

Deleting a connection removes it together with its associated requirements.

Pasos

1. Inicia sesión en Test Manager como administrador.
2. Abra su proyecto.
3. Go to Project Settings.
4. In the Integration list, select a webhook connection to expand the panel.
5. Selecciona Eliminar para eliminar la conexión.
6. Selecciona Aceptar para confirmar.

Resultado

The webhook connection and its associated requirements are deleted.