手動で通知をトリガーするためのAPI

エンドポイント

POST /api/events/settings/alertingChannels/notify/{id}

ユース・ケース

オンライン編集

手動または自動化を使用して）問題の解決を試みた後、関連する利害関係者に通知する必要があります。
このAPIは、ユーザーがイベントまたはインシデント内でアラート・チャンネルを手動でトリガーすることを可能にします。

要求ペイロード

オンライン編集

以下のリクエストペイロードサンプルを参照のこと：

{
    "eventId": "eventIdToTriggerAlertFor",
    "customPayloadFields": [
        {
            "type": "staticString",
            "key": "hello",
            "value": "world"
        },
        {
            "type": "staticString",
            "key": "alert",
            "value": "payload"
        }
    ]
}

権限

オンライン編集

APIを使用するには、 canInvokeAlertChannel のパーミッションが必要です。

ペイロードの詳細

オンライン編集

eventId (文字列、必須）：アラートに関連するイベントのID。
customPayloadFields (配列、オプション)：アラートペイロードに含まれるキーと値のペアのリスト。
- 配列の各オブジェクトには
- type:ペイロードフィールドのタイプを指定する（例： staticString ）。
- key:キー名。
- value:対応する値。

予期される応答

オンライン編集

成功(200 OK)： アラートチャネルが正常にトリガーされました。
エラー（400 Bad Request） ：無効なリクエストペイロードです。
エラー（404 Not Found） ：アラートチャネルIDが存在しません。
エラー（500 Internal Server Error） ：予期しないサーバーエラーです。

追加のメモ

オンライン編集

customPayloadFields セクションはオプション。
このAPIは、アラート・チャンネルをテストするための既存の PUT /api/events/settings/alertingChannels/{id} APIを補完する。
リクエストを行う前に、アラート・チャンネルIDが有効であることを確認する。