Make the MongoDB docs better! We value your opinion. Share your feedback for a chance to win $100.
Click here >
Docs Menu
Docs Home
/ /

Configuración de alerta global de prueba

Activa una notificación de prueba para un método específico de notificación en una configuración global de alertas. Este endpoint envía una carga útil de prueba con datos ficticios y plantillas renderizadas para validar tu configuración de webhook.

POST /api/public/v1.0/globalAlertConfigs/{ALERT-CONFIG-ID}/{NOTIFICATION-ID}/test
Parameter
Tipo
Descripción

ALERT-CONFIG-ID

string

string única de 24dígitos hexadecimales que identifica la configuración de alerta global.

NOTIFICATION-ID

string

string única de 24dígitos hexadecimales que identifica el método de notificación dentro de la configuración global de alertas.

Este endpoint no utiliza parámetros de query de solicitudes HTTP.

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Si estableces el parámetro de consulta pretty=truela respuesta se muestra en un formato legible.

Parameter
Tipo
Descripción

éxito

booleano

Indicador 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, WEBHOOK, EMAIL).

details.destination

string

Destino a donde se envió la notificación de prueba. Para webhooks, esta es la URL del webhook.

details.timestamp

string

Marca de tiempo ISO 8601 en la que se envió la notificación de prueba.

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/globalAlertConfigs/{ALERT-CONFIG-ID}/{NOTIFICATION-ID}/test?pretty=true"
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
{
"success": true,
"message": "Test notification sent successfully",
"details": {
"notificationType": "WEBHOOK",
"destination": "https://example.com/webhook",
"timestamp": "2025-01-15T10:30:00Z"
}
}

Volver

Borrar

En esta página