Webhooks

Test Manager proporciona webhooks que permiten que herramientas externas se suscriban a eventos en Test Manager.

Actualmente, se admiten los siguientes eventos.

• Crear defecto: este evento se desencadena cada vez que un usuario invoca la tarea "Crear defecto" a partir de un resultado de caso de prueba. Permite que las herramientas externas de gestión de defectos reciban informes de defectos con información de registro de los resultados de las pruebas.
• KPI de defectos: este evento se invoca cuando se actualizan los KPI de defectos en el panel de Test Manager. Esto permite incluir estadísticas de sistemas de gestión de defectos externos que se mostrarán en el panel de Test Manager.

Contratos

En esta sección puedes encontrar los detalles de la carga útil de solicitud y respuesta para cada evento.

Crear defecto.

Test Manager activa webhooks registrados con la siguiente carga útil:

Utiliza la API REST de Test Manager para obtener detalles sobre la prueba fallida para añadir información al defecto creado.

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.

KPI de defectos

Test Manager activa webhooks registrados con la siguiente carga útil:

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 una conexión de Webhook

Registra un punto final de webhook en Test Manager para que las herramientas externas reciban cargas útiles de eventos, como la creación de defectos o las actualizaciones de KPI, de tu proyecto.

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 en el menú 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 needs to be shown in the project dashboard.

     

6. Selecciona Guardar.
7. Selecciona la conexión para expandir el panel y copia la clave API para su uso posterior.

Administrar conexiones de WebHooks

La siguiente table muestra las acciones que puedes tomar para gestionar tus conexiones WebHook.

Acción	Descripción	Procedimiento
Editar	Editar su configuración de conexión.	Inicia sesión en Test Manager como administrador. Abra su proyecto. Ve a Configuración del proyecto . En la lista Integración, selecciona una conexión WebHook para expandir el panel. Selecciona Editar para configurar la conexión. Selecciona Guardar para confirmar.
Eliminar	Eliminar la conexión seleccionada y sus requisitos asociados.	Inicia sesión en Test Manager como administrador. Abra su proyecto. Ve a Configuración del proyecto . En la lista Integración, selecciona una conexión WebHook para expandir el panel. Selecciona Eliminar para eliminar la conexión. Selecciona Aceptar para confirmar.

Artículos relacionados

Sincronización de defectos

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 desde el proyecto conectado.