Activa una notificación de prueba para un método de notificación específico en la configuración de alertas del proyecto. Este punto final envía una carga de prueba con datos ficticios y plantillas renderizadas para validar la configuración del webhook.
Solicitud
POST /api/public/v1.0/groups/{GROUP-ID}/alertConfigs/{ALERT-CONFIG-ID}/{NOTIFICATION-ID}/test
Parámetros de la ruta de solicitud
Parameter | Tipo | Descripción |
|---|---|---|
ID DE GRUPO | string | Cadena de dígitos hexadecimales 24única que identifica el proyecto. |
ALERT-CONFIG-ID | string | Cadena de dígitos hexadecimales 24única que identifica la configuración de alerta. |
ID DE NOTIFICACIÓN | string | string única de 24dígitos hexadecimales que identifica el método de notificación dentro de la configuración de alertas. |
Parámetros de consulta de solicitud
Este punto final no utiliza parámetros de consulta de solicitud HTTP.
Parámetros del cuerpo de la solicitud
Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.
Respuesta
Elementos de respuesta
Si establece el parámetro de consulta pretty=true, la respuesta se muestra en un formato legible.
Parameter | Tipo | Descripción |
|---|---|---|
éxito | booleano | Bandera que indica si la notificación de prueba se envió correctamente. |
Mensaje | string | Mensaje legible por humanos que describe el resultado de la operación de prueba. |
detalles | Objeto | Detalles adicionales sobre la notificación de prueba. |
details.notificationType | string | Tipo de notificación que se probó (por ejemplo, |
detalles.destino | string | Destino donde se envió la notificación de prueba. Para webhooks, esta es la URL del webhook. |
detalles.marca de tiempo | string | Marca de tiempo ISO 8601 cuando se envió la notificación de prueba. |
Ejemplo de solicitud
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://ops-manager.example.com:8080/api/public/v1.0/groups/{GROUP-ID}/alertConfigs/{ALERT-CONFIG-ID}/{NOTIFICATION-ID}/test?pretty=true"
Ejemplo de respuesta
Encabezado de respuesta
200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes}
Cuerpo de respuesta
{ "success": true, "message": "Test notification sent successfully", "details": { "notificationType": "WEBHOOK", "destination": "https://example.com/webhook", "timestamp": "2025-01-15T10:30:00Z" } }