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

オンラインで編集

ユース・ケース

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

要求ペイロード

オンラインで編集

以下のサンプルリクエストペイロードを参照してください：

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

ペイロードの詳細

オンラインで編集
  • 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が有効であることを確認してください。