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が有効であることを確認してください。