Cancelando a assinatura da lista de distribuição

Para cancelar a assinatura da lista de distribuição, use o link no rodapé de qualquer e-mail que seja enviado na lista de distribuição.

Eventos para notificações

A tabela a seguir lista os tipos de eventos que o serviço Notifications envia para Event Notifications:

Adição de uma instância do Event Notifications à lista de distribuição de notificações

Antes de adicionar qualquer instância do site Event Notifications à lista de distribuição de notificações, certifique-se de que você já tenha uma instância do serviço Event Notifications na mesma conta da lista de distribuição. Se você não tiver uma instância do serviço Event Notifications, consulte Introdução ao Event Notifications. Para adicionar uma instância de serviço existente do Event Notifications à lista de distribuição de notificações, conclua as etapas a seguir:

1. Usando o console do IBM Cloud, acesse Gerenciar > Conta > Lista de distribuição de notificação.
2. Clique em Adicionar > Event Notifications.
3. Selecione uma instância de serviço Event Notifications na lista de instâncias Event Notifications. Se você não tiver uma instância do serviço Event Notifications que possa ser conectada à sua conta, poderá criar uma no catálogo IBM Cloud.
4. Clique em Incluir.

Não é possível adicionar uma instância do serviço Event Notifications à lista de distribuição de notificações que já está configurada.

Envio de notificações de teste para uma instância do Event Notifications

Depois de adicionar uma instância do Event Notifications à sua lista de distribuição de notificações, você pode testá-la para garantir que os eventos gerados pelo serviço Notifications sejam encaminhados para essa instância.

Conclua as etapas a seguir para enviar uma notificação de teste para uma instância do Event Notifications:

1. No console IBM Cloud, vá para Gerenciar > Conta > Lista de distribuição de notificações.
2. Selecione a instância do Event Notifications para a qual deseja enviar uma notificação de teste e clique no ícone de ações > Test.
3. Selecione o tipo de evento de notificação que você deseja testar e clique em Send test (Enviar teste ).
   1. Para reenviar a notificação de teste, clique em Reenviar teste.

Detalhes da carga útil de notificação

Quando uma instância do Event Notifications é adicionada à lista de distribuição de sua conta e a conta recebe uma notificação, uma carga de notificação é enviada para essa instância do Event Notifications. As propriedades do objeto de carga útil são as mesmas para todos os tipos de eventos. Veja o exemplo de carga útil a seguir, que contém informações detalhadas sobre um evento de manutenção para o envio de uma notificação de teste:

{
   "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"
           }
       ]
   }
}

Consulte a tabela a seguir para obter mais informações sobre as propriedades de carga útil da notificação para Event Notifications.

Excluindo uma instância do Event Notifications

Você pode excluir qualquer instância do site Event Notifications que tenha sido adicionada à lista de distribuição de notificações, executando as etapas a seguir:

1. Selecione a instância de serviço Event Notifications que você deseja excluir da lista de distribuição de notificações e clique no ícone Ações .
2. Clique em Excluir.

Cabeçalhos

Você recebe a carga útil com um cabeçalho que configurou na interface do usuário ao adicionar um webhook e com um cabeçalho de versão adicional que tem um número de versão semântico. Este versão do cabeçalho pode ser usada para determinar o formato esperado da carga útil do webhook.

O cabeçalho da versão atual é "IBM-Notifications-API-Version": "v2.0.0".

Valores de campo

As descrições a seguir fornecem informações sobre os valores de campo que estão sendo enviados dentro da carga útil:

body: este campo descreve o evento que está acontecendo na plataforma e requer sua atenção. Este campo contém uma descrição legível por humanos e detalhada da notificação e pode conter vários parágrafos longos. Ele também pode conter a formatação html. Este campo está configurado para suportar mais idiomas, embora apenas o inglês seja suportado atualmente.

category: o tipo do evento. Pode ser incidente, manutenção, anúncio ou boletins de segurança.

componentNames: se um serviço for impactado, este campo o representará. Esse também pode ser um valor global, como Component: IBM Cloud, e não apenas um serviço específico. Consulte os serviços na página do catálogo IBM Cloud.

regions: este campo mostra o local do evento.

severity: este campo refere-se à gravidade do evento. Pode ser gravidade 1, 2, 3 ou 4 para incidentes, alta, média ou baixa para manutenção e maior ou menor para comunicados. Consulte as descrições detalhadas a seguir sobre o nível de gravidade:

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

O atributo de gravidade na carga útil da solicitação pode assumir um valor de 0, 1, 2, 3 ou 4. A tabela a seguir lista os valores de gravidade e suas classificações correspondentes:

state: este campo é apenas para manutenção e notificações. Consulte os seguintes valores possíveis:

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

title: este campo informa sobre o que é a notificação. Este campo está configurado para suportar mais idiomas, embora apenas o inglês seja suportado atualmente.

startTime, endTime: é possível verificar quando o evento começa e quando ele termina.

Os campos startTime e endTime mostram o horário de início e o horário de término do evento em registros de data e hora da Hora Universal Coordenada do Unix.

Os campos que são enviados para dentro da carga útil podem ser necessários ou opcionais. Os campos opcionais, por exemplo, startTime, serão transmitidos se a notificação tiver esse tipo de informação e não serão se ela não tiver. Os campos obrigatórios, por exemplo, category, são transmitidos em todos os casos. A tabela a seguir lista quais campos são obrigatórios e quais são opcionais:

Campos adicionais podem ser adicionados no futuro sem uma grande mudança de versão. Isso significa que qualquer código que esteja processando notificações deve ser preparado para ignorar os campos que ele não reconhece.

Envio de notificações de teste para um webhook

Se você tiver concluído as etapas anteriores e tiver um webhook configurado, será possível testá-lo facilmente. Envie uma notificação de teste para o seu webhook e certifique-se de que a integração do webhook esteja funcionando corretamente e receba a notificação.

Conclua as etapas a seguir para enviar uma notificação de teste a um webhook:

1. Acesse Gerenciar > Conta > Lista de distribuição de notificação no console da IBM Cloud®.
2. Selecione o webhook para o qual deseja enviar uma notificação de teste e clique no ícone Ações .
3. Clique em Teste > Enviar teste.
4. Para reenviar a notificação de teste, clique em Reenviar teste.