Désabonnement de la liste de distribution

Pour vous désabonner de la liste de distribution, utilisez le lien dans le pied de page d'un courrier électronique envoyé à partir de la liste de distribution.

Événements pour les notifications

Le tableau suivant répertorie les types d'événements que le service Notifications envoie à Event Notifications:

Ajout d'une instance Event Notifications à la liste de distribution des notifications

Avant d'ajouter une instance Event Notifications à la liste de distribution des notifications, assurez-vous que vous disposez déjà d'une instance de service Event Notifications dans le même compte que la liste de distribution. Si vous n'avez pas d'instance de service Event Notifications, consultez la section Premiers pas avec Event Notifications. Pour ajouter une instance de service Event Notifications existante à la liste de distribution des notifications, procédez comme suit :

1. Depuis la console IBM Cloud, accédez à Gérer > Compte > Liste de distribution des notifications.
2. Cliquez sur Ajouter > Event Notifications.
3. Sélectionnez une instance de service Event Notifications dans la liste des instances Event Notifications. Si vous n'avez pas d'instance de service Event Notifications que vous pouvez connecter à votre compte, vous pouvez en créer une dans le catalogue IBM Cloud.
4. Cliquez sur Ajouter.

Vous ne pouvez pas ajouter une instance de service Event Notifications à la liste de distribution des notifications déjà configurée.

Envoi de notifications de test à une instance Event Notifications

Après avoir ajouté une instance Event Notifications à votre liste de distribution de notifications, vous pouvez la tester pour vous assurer que les événements générés par le service de notification sont bien transmis à cette instance.

Effectuez les étapes suivantes pour envoyer une notification de test à une instance Event Notifications:

1. Dans la console IBM Cloud, allez dans Gérer > Compte > Liste de distribution des notifications.
2. Sélectionnez l'instance Event Notifications à laquelle vous souhaitez envoyer une notification de test et cliquez sur l'icône Actions > Test.
3. Sélectionnez le type d'événement de notification que vous souhaitez tester, puis cliquez sur Envoyer le test.
   1. Pour renvoyer la notification test, cliquez sur Renvoyer le test.

Détails du contenu de la notification

Lorsqu'une instance Event Notifications est ajoutée à la liste de distribution de votre compte et que le compte reçoit une notification, une charge utile de notification est envoyée à cette instance Event Notifications. Les propriétés de l'objet payload sont les mêmes pour tous les types d'événements. L'exemple de charge utile suivant contient des informations détaillées sur un événement de maintenance pour l'envoi d'une notification de test :

{
   "instanceId": "12345678-abcd-1234-efgh-1234567890ab",
   "id": "CHG1234567",
   "source": "crn:v1:bluemix:public:notificationapi::a/<scope>:12345678-abcd-1234-efgh-1234567890ab::",
   "ibmenseverity": "high_impact",
   "severity": "high_impact",
   "ibmensourceid": "crn:v1:bluemix:public:notificationapi::a/<scope>:12345678-abcd-1234-efgh-1234567890ab::",
   "type": "com.ibm.cloud.notificationapi.maintenance",
   "time": "2025-10-08T18:31:09.363Z",
   "ibmendefaultshort": "Maintenance - High Impact: this is a maintenance test notif",
   "ibmendefaultlong": "this is a maintenance test notif \n \nSource ID: CHG1234567 \nType: Maintenance \nSeverity: High Impact \nStart Time: 23 Oct 2025, 7:09 PM UTC \nEnd Time: 24 Oct 2025, 7:09 PM UTC \nUpdate Time: 21 Oct 2025, 2:52 AM UTC \n\nthis is the body text and sev = 1\n\nThis is a test email, please disregard\n\n\n",
   "ibmensmstext": "Maintenance - High Impact: this is a maintenance test notif \nSource ID: CHG2755299 \nCategory: Maintenance \nSeverity: High Impact \n",
   "ibmensubject": "Maintenance - High Impact: this is a maintenance test notif",
   "ibmenhtmlbody": "<div> this is a maintenance test notif</div></br><div><div><b>Source ID:</b> CHG2755299</div><div><b>Type:</b> Maintenance</div><div><b>Severity:</b> High Impact</div><div><b>Start Time:</b> 23 Oct 2025, 7:09 PM UTC</div><div><b>End Time:</b> 24 Oct 2025, 7:09 PM UTC</div><div><b>Update Time:</b> 21 Oct 2025, 2:52 AM UTC</div></br>this is the body text and sev = 1</br></div><div></br><b>This is a test email, please disregard</b></br><div>",
   "specversion": "1.0",
   "datacontenttype": "application/json",
   "data": {
       "sourceID": "CHG1234567",
       "category": "maintenance",
       "severity": 1,
       "crnMasks": [],
       "startTime": "1761246551",
       "endTime": "1761332951",
       "title": [
           {
               "language": "en",
               "text": "this is a maintenance test notif"
           }
       ],
       "body": [
           {
               "content-type": "text/html",
               "language": "en",
               "text": "this is the body text and sev = 1"
           }
       ]
   }
}

Consultez le tableau suivant pour plus d'informations sur les propriétés de la charge utile de la notification pour Event Notifications.

Suppression d'une instance Event Notifications

Vous pouvez supprimer toute instance Event Notifications que vous avez ajoutée à la liste de distribution des notifications en suivant les étapes suivantes :

1. Sélectionnez l'instance de service Event Notifications que vous souhaitez supprimer de la liste de distribution des notifications et cliquez sur l'icône Actions .
2. Cliquez sur Supprimer.

En-têtes

Vous recevez la charge utile avec un en-tête que vous avez configuré dans l'interface utilisateur lorsque vous avez ajouté un webhook, et avec un en-tête de version supplémentaire qui contient un numéro de version sémantique. Cet en-tête de version peut être utilisé pour déterminer le format attendu du contenu de webhook.

L'en-tête de version en cours est "IBM-Notifications-API-Version": "v2.0.0".

Valeurs de zone

Les descriptions suivantes fournissent des informations sur les valeurs de zone envoyées dans le contenu :

body : Cette zone décrit l'événement qui se produit sur la plateforme et qui vous concerne. Cette zone contient une description détaillée et lisible par l'utilisateur de la notification et peut comprendre plusieurs paragraphes. Elle peut également inclure un formatage html. Cette zone est configurée pour prendre en charge plusieurs langues, bien que seul l'anglais soit pris en charge actuellement.

category : type de l'événement. Il peut s'agir d'un incident, d'une opération de maintenance, d'une annonce ou de bulletins de sécurité.

componentNames : si un service est affecté, cette zone le représente. Il peut également s'agir d'une valeur globale comme Component: IBM Cloud, et pas seulement d'un service spécifique. Voir les services sur la page du catalogue IBM Cloud.

regions : cette zone indique l'emplacement de l'événement.

severity : cette zone fait référence à la gravité de l'événement. Il peut s'agir d'une gravité 1, 2, 3 ou 4 pour les incidents, d'un niveau élevé, moyen ou faible pour les opérations de maintenance et d'une version majeure ou mineure pour les annonces. Reportez-vous aux descriptions détaillées des niveaux de gravité ci-dessous :

* **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.

L'attribut de gravité dans la charge utile de la demande peut prendre une valeur de 0, 1, 2, 3 ou 4. Le tableau suivant énumère les valeurs de gravité et les classifications correspondantes :

state : Cette zone est réservée à la maintenance et aux notifications. Les valeurs possibles sont les suivantes :

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

title : La zone de titre indique l'objet de la notification. Cette zone est configurée pour prendre en charge plusieurs langues, bien que seul l'anglais soit pris en charge actuellement.

startTime, endTime : vous pouvez vérifier à quel moment l'événement démarre et se termine.

Les zones startTime et endTime indiquent l'heure de début et l'heure de fin de l'événement à l'aide d'horodatages au format Temps Universel Coordonné (UTC) Unix.

Les zones envoyées dans le contenu peuvent être obligatoires ou facultatives. Les zones facultatives (par exemple, startTime) sont transmises si la notification contient ce type d'information et ne le sont pas dans le cas contraire. Les zones requises (par exemple, category) sont transmises dans tous les cas. Le tableau suivant répertorie les zones requises et facultatives :

Des champs supplémentaires peuvent être ajoutés à l'avenir sans qu'une modification majeure de la version soit nécessaire. Cela signifie que tout code qui traite les notifications doit être conçu de manière à ignorer les zones qu'il ne reconnaît pas.

Envoi de notifications de test à un webhook

Si vous avez effectué les étapes précédentes et qu'un webhook est configuré, vous pouvez le tester. Envoyez une notification test à votre webhook et assurez-vous que votre intégration de webhook fonctionne correctement et reçoit la notification.

Procédez comme suit pour envoyer une notification test à un webhook :

1. Accédez à Gérer > Compte > Liste de distribution de notification dans la console IBM Cloud.
2. Sélectionnez le webhook auquel vous souhaitez envoyer une notification de test, puis cliquez sur l'icône Actions .
3. Cliquez sur Test > Envoyer un test.
4. Pour renvoyer la notification test, cliquez sur Renvoyer le test.