IBM Cloud Docs
Utilización de la lista de distribución de notificaciones

Utilización de la lista de distribución de notificaciones

La página de lista de distribución de notificaciones IBM Cloud le proporciona una manera de especificar un conjunto de direcciones de correo electrónico o webhooks para establecer destinos adecuados para notificaciones sobre eventos de toda la cuenta.

Puede gestionar la lista de distribución de notificaciones utilizando la consola de IBM Cloud. Puede crear una lista de hasta 10 direcciones de correo electrónico pueden recibir notificaciones. Los correos electrónicos que se añadan a la lista de distribución recibirán una notificación sobre cualquier suceso que afecte a la cuenta. Debe tener el rol de editor o superior en el servicio de gestión de cuentas para añadir direcciones de correo electrónico a la lista de distribución. Para obtener más información, consulte Asignación de acceso a los servicios de gestión de cuentas.

Las direcciones de correo electrónico añadidas a la lista de distribución por el propietario de la cuenta reciben notificaciones sobre cualquier incidente, mantenimiento, anuncio o boletín de seguridad que aparezca en la página de Notificaciones del propietario de la cuenta.

Además de añadir direcciones de correo electrónico, también puede añadir hasta 10 webhooks a una lista de distribución. Los administradores de cuentas pueden crear y utilizar webhooks para configurar una aplicación para recibir notificaciones asíncronas siempre que se produzca un suceso de plataforma. Los webhooks registrados envían la información al URL especificado en forma de una solicitud HTTP POST con una carga útil JSON. El content-type de la solicitud es application/json.

Añadir direcciones de correo electrónico a una lista de distribución de notificaciones en la consola

Para añadir correos electrónicos a una lista de distribución de notificaciones, siga estos pasos:

  1. Utilizando la consola de IBM Cloud, vaya a Gestionar > Cuenta > Lista de distribución de notificaciones.

  2. Seleccione Añadir > Correo electrónico.

  3. Especifique un nombre y una dirección de correo electrónico.

    Puede añadir un máximo de 10 direcciones de correo electrónico a la lista de distribución. Las direcciones de correo electrónico no es necesario que se correspondan con usuarios conocidos en IBM Cloud; puede añadir cualquier tipo.

  4. Pulse Añadir.

Eliminación de la suscripción a la lista de distribución

Para anular la suscripción de la lista de distribución, utilice el enlace del pie de página de cualquier correo electrónico enviado desde la lista de distribución.

Habilitación de Event Notifications para la lista de distribución de notificaciones

Con IBM Cloud® Event Notifications, puede elegir entregar sus notificaciones a distintos destinos, incluyendo correo electrónico, SMS o webhooks. Event Notifications es una alternativa a la lista de distribución de notificaciones. Proporciona una forma de que se le notifique sobre los sucesos críticos que se producen en su cuenta y de gestionar las notificaciones a escala. Para obtener más información, consulte Iniciación a las notificaciones de sucesos de Event Notifications.

Cuando se produce un suceso de interés en la plataforma IBM Cloud y se genera un suceso, la lista de distribución de notificaciones se comunica con una instancia de Event Notifications conectada para reenviar una notificación al destino soportado. Para obtener más información sobre los destinos Event Notifications soportados, consulte Destinos de sucesos.

Adición de una instancia de Event Notifications a la lista de distribución de notificaciones

Antes de poder añadir cualquier instancia de ' Event Notifications ' a la lista de distribución de notificaciones, asegúrese de que ya tiene un ' instancia de servicio Event Notifications ' que está en la misma cuenta que la lista de distribución. Si no tiene una instancia del servicio Event Notifications, consulte Introducción a Event Notifications. Para añadir una instancia de servicio Event Notifications existente a la lista de distribución de notificaciones, siga estos pasos:

  1. Utilizando la consola de IBM Cloud, vaya a Gestionar > Cuenta > Lista de distribución de notificaciones.
  2. Pulse Añadir > Event Notifications.
  3. Seleccione una instancia de servicio de Event Notifications en la lista de instancias de Event Notifications. Si no tiene una instancia de servicio de Event Notifications que pueda conectar a su cuenta, puede crear una en el catálogo deIBM Cloud.
  4. Pulse Añadir.

No puede añadir una instancia de servicio de Event Notifications a la lista de distribución de notificaciones que ya está configurada.

Supresión de una instancia de Event Notifications

Puede suprimir cualquier instancia de Event Notifications que haya añadido a la lista de distribución de notificaciones realizando los pasos siguientes:

  1. Seleccione la instancia de servicio Event Notifications que desea suprimir de la lista de distribución de notificaciones y pulse el icono Acciones Acciones.
  2. Pulse Suprimir.

Adición de webhooks a una lista de distribución

Para añadir webhooks a una lista de distribución, siga estos pasos:

  1. Vaya a Gestionar > Cuenta > Lista de distribución de notificaciones en la consola de IBM Cloud®.

  2. Pulse Añadir y seleccione Añadir webhook.

  3. Introduzca un nombre identificador para su webhook y un endpoint URL, donde se enviarán las notificaciones sobre eventos cuando se active el webhook. Configure el URL que será su propio punto final personalizado.

    Los campos de cabecera personalizada y de cabecera segura también están disponibles para su establecimiento. Puede especificarlos pulsando Añadir cabecera o Añadir cabecera segura. Si elige añadir una cabecera segura para las credenciales, se pasan cifradas con los datos privados. Este tipo de cabecera se puede suprimir, pero no se puede editar más tarde. Posteriormente puede editar y suprimir fácilmente cabeceras personalizadas.

    Si ya no desea recibir notificaciones, puede suprimir fácilmente el webhook de la lista de distribución pulsando el icono Acciones Icono Acciones > Suprimir en la fila del webhook.

    Puede seleccionar qué cuenta de IBM Cloud utiliza pulsando el conmutador de cuenta en la consola. Los usuarios de la cuenta seleccionada reciben notificaciones sobre cualquier suceso que afecte a la cuenta.

Cuando recibe una notificación a través de un webhook, se envía una carga útil al punto final de webhook (URL) dado y le informa de todos los detalles de un suceso que se produce. Consulte el ejemplo siguiente:

{
  "account_id": "2dd2d2de4add4a098ebd0999be5cc555",
  "body": [
    {
      "language": "en",
      "text": "<p><br />SERVICES/COMPONENTS AFFECTED:<br />- Cloudant NoSQL DB<br />- Code Engine<br />- DNS Services<br />- App ID<br />- IBM Watson Machine Learning<br />- Continuous Delivery - Toolchain<br />- MQ in IBM Cloud<br />- Hyper Protect Crypto Services<br /><br />IMPACT:<br />- Users may experience connectivity issues when trying to connect to Cloudant services.<br /><br />STATUS:<br />- 2021-05-25 14:54 UTC - INVESTIGATING - We are aware of the issue and are currently investigating. More information will be provided as it becomes available.</p>"
    }
  ],
  "category": "Incident",
  "componentNames": "Cloudant",
  "continentNames": [
    "North America",
    "Europe",
    "Asia Pacific"
  ],
  "regionNames": [
    "Washington DC",
    "London",
    "Dallas",
    "Sydney",
    "Tokyo",
    "Frankfurt"
  ],
  "regions": [
    "us-east",
    "eu-gb",
    "us-south",
    "au-syd",
    "jp-tok",
    "eu-de"
  ],
  "severity": "Severity 1",
  "sourceID": "INC3918600",
  "startTime": 1621949594,
  "state": "Investigating",
  "title": [
    {
      "language": "en",
      "text": "INVESTIGATING: IBM Cloudant - selective services  are unavailable"
    }
  ],
  "updateTime": 1621954682
}

Cabeceras

Recibes la carga útil con una cabecera que configuraste en la interfaz de usuario cuando añadiste un webhook, y con una cabecera de versión adicional que tiene un número de versión semántico. Esta cabecera de versión se puede utilizar para determinar el formato esperado de la carga útil de webhook.

La cabecera de versión actual es "IBM-Notifications-API-Version": "v2.0.0".

Valores de campos

Las descripciones siguientes proporcionan información sobre los valores de campos que se envían dentro de la carga útil:

body: este campo describe el suceso que se está produciendo en la plataforma y que le atañe. Este campo contiene una descripción detallada y legible para una persona de la notificación y puede tener varios párrafos. También puede contener formato html. Este campo está configurado para dar soporte a más idiomas, aunque actualmente solo se admite el inglés.

category: el tipo del suceso. Puede ser incidente, mantenimiento, anuncio o boletines de seguridad.

componentNames: Si un servicio se ve afectado, este campo lo representa. También puede ser un valor global como Component: IBM Cloud, no sólo un servicio específico. Consulte los servicios en la página del catálogo IBM Cloud.

regions: este campo muestra la ubicación del suceso.

severity: este campo hace referencia a la gravedad del suceso. Puede ser gravedad 1, 2, 3 o 4 para incidencias, alto, medio o bajo para mantenimiento y principal o secundario para anuncios. Consulte las siguientes descripciones detalladas del nivel de gravedad:

* **Incidents**
  * `Severity 1`: Business-critical functionality is inoperable or critical interference failed. This severity usually applies to the production environment and the inability to access services is causing a critical impact on operations.
  * `Severity 2`: Core functionality is impacted. Service is operational but causing major impact on usage.
  * `Severity 3`: Partial or noncritical disruption to functionality with minimal or isolated impact.
  * `Severity 4`: A minor issue that requires action, but does not impact functionality or usage.
* **Maintenance**
  * `High impact`: Maintenance will, or is likely to cause service outages and disruptions.
  * `Medium impact`: Maintenance will, or is likely to cause measurable service degradation but not an actual outage.
  * `Low impact`: Maintenance will cause no service disruption during or after the maintenance window.
* **Announcements**
  * `Major`: Important incidents such as legal notices, service deprecation, or security patches.
  * `Minor`: Informative announcements such as product enhancements.

El atributo de gravedad en la carga útil de la solicitud puede tomar un valor de 0, 1, 2, 3 o 4.

state: este campo solo tiene fines de mantenimiento y notificaciones. Consulte los siguientes valores posibles:

* Values for *Maintenance* states: Planned, In progress, Completed, Canceled, Failed
* Values for *Incident* states: New issue, Investigating, Resolved

title: el campo de título indica de qué se trata la notificación. Este campo está configurado para dar soporte a más idiomas, aunque actualmente solo se admite el inglés.

startTime, endTime: puede comprobar cuándo se inicia y cuando finaliza el suceso.

Los campos startTime y endTime muestran la hora de inicio y la hora de finalización del suceso en indicaciones de fecha y hora de hora universal coordinada (UTC) de Unix.

Los campos que se envían en la carga útil pueden ser obligatorios u opcionales. Los campos opcionales, por ejemplo startTime, se pasan si la notificación tiene este tipo de información y no se pasan si la notificación no la tiene. Los campos necesarios, por ejemplo category, se pasan en todos los casos. La tabla siguiente lista qué campos son necesarios y cuáles son opcionales:

Campos de una carga útil
Campo Obligatorio u opcional
account_id: account_id Obligatorio
category: notification.category Obligatorio
title: notification.title Obligatorio
startTime: notification.startTime Opcional
endTime: notification.endTime Opcional
updateTime: notification.updateTime Opcional
body: notification.body Obligatorio
state: notification.state Opcional
sourceID: notification.sourceID Opcional
regions: notification.regions Opcional
continentNames: notification.continentNames Opcional
regionNames: notification.regionNames Opcional
componentNames: notification.componentNames Opcional
subCategory: notification.subCategory Opcional
severity: notification.severity Opcional

Es posible que en el futuro se añadan campos adicionales sin necesidad de modificar la versión. Esto significa que cualquier código que esté procesando notificaciones debe estar preparado para ignorar los campos que no reconoce.

Envío de notificaciones de prueba a un webhook

Si está preparado con los pasos anteriores y tiene un webhook configurado, puede probarlo fácilmente. Envíe una notificación de prueba a su webhook y asegúrese de que la integración de webhook está funcionando correctamente y que recibe la notificación.

Siga estos pasos para enviar una notificación de prueba a un webhook:

  1. Vaya a Gestionar > Cuenta > Lista de distribución de notificaciones en la consola de IBM Cloud.
  2. Seleccione el webhook al que desea enviar una notificación de prueba y pulse el icono Acciones Acciones.
  3. Pulse Probar > Enviar prueba.
  4. Para volver a enviar la notificación de prueba, pulse Reenviar prueba.

Adición de webhooks de Slack a una lista de distribución

Puede añadir webhooks de Slack a su lista de distribución y recibir notificaciones de toda la cuenta IBM Cloud a través de ellos.

Para crear un webhook, primero configure una aplicación en Slack y cree el webhook entrante, que proporciona el URL exclusivo donde puede enviar el texto del mensaje de notificación en forma de una carga útil JSON. Recibirá las notificaciones en el canal de Slack seleccionado en el que instaló su aplicación. Para obtener más información, consulte Envío de mensajes mediante Webhooks entrantes.

Para añadir un webhook de Slack en la consola de IBM Cloud, realice los pasos siguientes:

  1. Vaya a Gestionar > Cuenta > Lista de distribución de notificaciones en la consola de IBM Cloud.
  2. Pulse Añadir y seleccione Slack.
  3. Especifique un nombre para el webhook y un URL de webhook de Slack. Las notificaciones se envían a este URL exclusivo.

Adición de webhooks de Microsoft Teams a una lista de distribución

La adición de webhooks de Microsoft Teams a la lista de distribución también está disponible para que reciba notificaciones de IBM Cloud de toda la cuenta.

Para crear un webhook en la consola de IBM Cloud, cree primero el webhook entrante en Microsoft Teams. Esto permite que las aplicaciones externas compartan contenido en los canales de Teams y proporciona el URL exclusivo donde puede enviar el texto del mensaje de notificación en forma de una carga útil de JSON. Recibirá las notificaciones en el canal de Teams seleccionado en el que ha añadido el webhook entrante. Para más información, consulte Crear Webhook entrante.

Para añadir un webhook de Microsoft Teams en la consola de IBM Cloud, realice los pasos siguientes:

  1. Vaya a Gestionar > Cuenta > Lista de distribución de notificaciones en la consola de IBM Cloud.
  2. Pulse Añadir y seleccione Microsoft Teams.
  3. Especifique un nombre para el webhook y un URL de webhook de Microsoft Teams. Las notificaciones se envían a este URL exclusivo.

Configuración de webhooks en ServiceNow

A diferencia de las integraciones de webhook de Microsoft Teams y Slack, la configuración de un webhook de ServiceNow requiere que se realice la configuración en el lado de destino del webhook.

En primer lugar, debe crear una API REST con scripts en el sitio web de ServiceNow. Después de configurar la API REST con scripts, también debe crear un recurso de API REST con scripts. El método de solicitud debe establecerse en HTTP POST. A continuación, debe proporcionar un código para que se ejecute el recurso.

Cuando esté preparado con el proceso y tenga el URL para la API REST con scripts, puede empezar a utilizarlo en la página IBM Cloud Lista de distribución de notificaciones y crear webhooks.

Para conocer el proceso completo de integración de webhooks en ServiceNow, siga las instrucciones de la entrada de blog Cómo integrar webhooks en ServiceNow. Este blog le guía detalladamente a través de los pasos.