取消訂閱分發清單

若要取消訂閱分發清單，請使用分發清單發送的任何電子郵件腳部的連結。

通知的事件

下表列出了通知服務傳送至 Event Notifications 的事件類型：

將 Event Notifications 範例加入通知分發清單

在您可以將任何 Event Notifications 範例新增至通知分發清單之前，請確定您已經擁有與分發清單在同一帳戶中的 Event Notifications 服務範例。 如果您沒有 Event Notifications 服務實例，請參閱 Event Notifications 入門。 若要將現有的 Event Notifications 服務實例新增至通知散佈清單，請完成下列步驟：

1. 使用 IBM Cloud 主控台，移至管理 > 帳戶 > 通知分發清單。
2. 按一下 新增 > Event Notifications。
3. 從 Event Notifications 範例清單中選取 Event Notifications 服務範例。 如果您沒有可以連接到帳戶的 Event Notifications 服務實例，您可以在 IBM Cloud 目錄中建立一個。
4. 按一下新增。

您不能將 Event Notifications 服務實例新增至已設定的通知分發清單。

將測試通知傳送至 Event Notifications 範例

將 Event Notifications 實例新增至通知分發清單後，您可以測試該實例，以確保由通知服務產生的事件都被轉發至該實例。

完成下列步驟，將測試通知傳送至 Event Notifications 範例：

1. 在 IBM Cloud 主控台中，移至管理 > 帳戶 > 通知分發清單。
2. 選取要傳送測試通知的 Event Notifications 範例，然後按一下動作圖示 > 測試。
3. 選取您要測試的通知事件類型，然後按一下傳送測試。
   1. 若要重新傳送測試通知，請按一下重新傳送測試。

通知有效負載詳細資訊

當 Event Notifications 範例新增至您帳戶的傳送清單，且該帳戶收到通知時，通知有效負載會傳送至該 Event Notifications 範例。 所有事件類型的 payload 物件屬性都相同。 請參閱以下的有效負載範例，其中包含傳送測試通知的維護事件的詳細資訊：

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

檢視下表，以取得更多關於通知的有效負載屬性的資訊：Event Notifications。

刪除 Event Notifications 範例

您可以透過完成下列步驟，刪除任何已新增至通知分發清單的 Event Notifications 範例：

1. 選擇要從通知分發清單中刪除的 Event Notifications 服務實例，然後按一下動作圖示。
2. 按一下刪除。

標頭

您收到的有效負載會附有您新增 webhook 時在使用者介面中設定的標頭，以及附有語意版本號碼的附加版本標頭。 此版本標頭可用於確定 webhook 有效負載的預期格式。

目前的版本標頭為 "IBM-Notifications-API-Version": "v2.0.0"。

欄位值

以下說明提供有關在有效負載內傳送的欄位值的資訊：

body:此欄位描述平台上發生且與您有關的事件。 此欄位包含通知的詳細、人類可讀的說明，可長達數個段落。 它也可以包含 html 格式。 此欄位已設定為支援更多的語言，雖然目前只支援英文。

category:事件類型。 這可以是事件、維護、公告或安全公告。

componentNames:如果服務受到影響，此欄位代表該服務。 這也可以是一個全局值，例如 Component: IBM Cloud，而不只是特定的服務。 請參閱 IBM Cloud 目錄頁面上的服務。

regions:此欄位顯示事件的位置。

severity:此欄位指事件的嚴重性。 事件的嚴重程度可以是 1、2、3 或 4，維護的嚴重程度可以是高、中或低，公告的嚴重程度可以是大或小。 請參閱下列詳細的嚴重性等級說明：

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

請求有效負載中的嚴重性屬性值可以是 0、1、2、3 或 4。 下表列出嚴重程度值及其對應的分類：

state:此欄位只用於維護和通知。 請參閱下列可能的值：

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

title:標題欄位會告訴您通知的內容。 此欄位已設定為支援更多的語言，雖然目前只支援英文。

startTime, endTime: 您可以檢查事件開始和結束的時間。

startTime 和 endTime 欄位顯示事件的開始時間和結束時間（ Unix Coordinated Universal Time 時間戳記）。

在 payload 中傳送的欄位可以是必填欄位，也可以是選填欄位。 可選欄位，例如 startTime，如果通知有這類資訊，就會傳送；如果通知沒有這類資訊，就不會傳送。 必填欄位，例如 category，在任何情況下都會傳送。 下表列出哪些欄位是必填欄位，哪些是選填欄位：

將來可能會增加額外的欄位，而不需要進行重大的版本變更。 這表示任何處理通知的程式碼都應該準備忽略無法辨識的欄位。

傳送測試通知至 webhook

如果您已準備好前面的步驟，並已設定好 webhook，就可以輕鬆測試。 傳送測試通知到您的 webhook，並確保您的 webhook 整合正常運作，並能接收到通知。

完成下列步驟，將測試通知傳送至 webhook：

1. 移至 IBM Cloud 主控台中的管理 > 帳戶 > 通知分發清單。
2. 選取您要傳送測試通知的 webhook，然後按一下 Actions 圖示 。
3. 按一下測試 > 傳送測試。
4. 若要重新傳送測試通知，請按一下重新傳送測試。