Configurar webhooks

Activados por determinadas alertas, los webhooks envían datos a otras aplicaciones mediante HTTP POST. Cada vez que se produce una alerta, el origen envía una solicitud HTTP a la aplicación de destino configurada para el webhook. SD-WAN Orchestrator admite los webhooks que envían automáticamente mensajes a través de HTTP POST a las aplicaciones de destino cuando se produce un evento. Es posible establecer la dirección URL de destino en el portal de empresas y automatizar las acciones en respuesta a las alertas activadas por SD-WAN Orchestrator. Los destinatarios de los webhooks deben admitir HTTPS y deben tener certificados válidos para garantizar la privacidad de las cargas de alertas potencialmente confidenciales. Esto también evita la alteración de las cargas útiles.

La página Webhooks de la ventana Configuración de alertas (Alert Configuration) permite configurar los siguientes detalles:


Opción	Descripción
Dirección URL (URL)	Introduzca una dirección URL HTTPS válida. Esta funciona como la aplicación de destino para los webhooks.
Código	Introduzca un código de estado de respuesta HTTP esperado para cada destinatario de webhook. De forma predeterminada, SD-WAN Orchestrator espera que los destinatarios de webhooks respondan a las solicitudes HTTP POST con un código de estado como HTTP 200. Cuando SD-WAN Orchestrator recibe un código de estado inesperado de un servidor de destinatario o un servidor proxy, considera que se produjo un error en la entrega de la alerta y genera un evento de cliente `ALERT_DELIVERY_FAILED`. Este evento ayuda a identificar cuándo es posible que un servidor de destinatario de webhook no funcione según lo esperado.
Secreto (Secret)	Especifique un token secreto para cada destinatario de webhook configurado. Esto se utiliza para calcular un HMAC para cada solicitud de webhook enviada al destinatario correspondiente. El HMAC se integra en un encabezado HTTP `X-Webhook-Signature`, junto con un parámetro de versión, para identificar el algoritmo de firma y una marca de tiempo. X-Webhook-Signature: v=<signature-version>&t=<timestamp>&s=<hmac> El destinatario interpreta los componentes de la siguiente manera: `v`: versión del algoritmo que se utiliza para generar la firma. El único valor admitido es 1. `t`: marca de tiempo con precisión de milisegundos correspondiente a la hora en la que se emite la solicitud. `s`: HMAC calculado por SD-WAN Orchestrator. El HMAC se calcula de la siguiente manera: `HMAC-SHA256(request-body + '.' + timestamp, secret)`. El mensaje que se utiliza para calcular el HMAC es una concatenación del cuerpo de la solicitud, un solo punto y el valor del parámetro de marca de tiempo que se muestra en el encabezado de firma. El algoritmo HMAC específico utilizado para generar el código es HMAC-SHA256. Después de recibir una solicitud de webhook, el servidor de escucha puede verificar la autenticidad de la solicitud. Para ello, el servidor calcula su propia firma HMAC-SHA256 con el mismo algoritmo y compara la firma recientemente calculada con la generada por SD-WAN Orchestrator.
Plantilla de carga útil de JSON (JSON Payload Template)	Este campo es obligatorio. SD-WAN Orchestrator envía notificaciones de alerta a cada destinatario de webhook a través de una carga de JSON contenida en el cuerpo de una solicitud HTTP POST saliente. SD-WAN Orchestrator genera contenido de carga de forma dinámica, ya que las notificaciones se envían mediante la interpolación de variables. Las variables de marcador de posición admitidas en la plantilla de carga configurada por el usuario se reemplazan por valores específicos de alerta.
Verificar	Haga clic en esta opción para validar los detalles introducidos.

Haga clic en el vínculo Configurar plantilla de carga útil (Configure Payload Template) bajo la opción Plantilla de carga útil de JSON (JSON Payload Template) para configurar lo siguiente:


Opción	Descripción
Hora de alerta	Introduzca la fecha y la hora a las que se debe activar la alerta.
Tipo de alerta	Seleccione el tipo de alerta en el menú desplegable. De forma predeterminada, se muestra como N/D (N/A).
ID lógico de cliente	Introduzca el identificador lógico del cliente al que se le envía la notificación.
Cliente	Introduzca el nombre del cliente al que se debe enviar la notificación.
Identificador lógico de dispositivo	Introduzca el identificador lógico de la instancia de Edge a la que se aplica la alerta.
Descripción del dispositivo	Introduzca un mensaje breve donde se describe la instancia de Edge a la que se aplica la alerta.
Número de serie del dispositivo	Introduzca el número de serie de la instancia de Edge a la que se aplica la alerta.
Nombre del dispositivo	Introduzca el nombre de la instancia de Edge a la que se debe aplicar la alerta.
Último contacto (Last Contact)	Introduzca la fecha y la hora en que la instancia de Edge afectada se comunicó por última vez con SD-WAN Orchestrator. Esto solo se aplica a las alertas de Edge.
VCO	Introduzca el nombre de host o dirección IP pública de SD-WAN Orchestrator desde donde se envía la notificación.
Mensaje (Message)	Introduzca un breve mensaje que describa el evento que debe activar la alerta.
Entidad afectada	Introduzca el nombre de la entidad: instancia de Edge o vínculo, o la VNF a la que se aplica la alerta.

En el siguiente ejemplo, se proporciona una plantilla de carga de JSON de muestra:

{
   "alertTime": "alertTime",
   "alertType": "alertType",      
   "customer": "customer",
   "customerLogicalId": "customerLogicalId",
   "entityAffected": "entityAffected",
   "deviceLogicalId": "deviceLogicalId",
   "lastContact": "lastContact",
   "message": "message",
   "vco": "vco",
   "deviceName": "deviceName",
   "deviceDescription": "deviceDescription",
   "deviceSerialNumber": "deviceSerialNumber"
}

Haga clic en Guardar (Save) y, a continuación, haga clic en Guardar cambios (Save Changes) en la página Webhooks para guardar las configuraciones de webhooks.

Cada vez que se active una alerta, se enviará un mensaje de alerta junto con la información relevante a la dirección URL de destino.