アラート統合のカスタムペイロード
Instance Observer 統合を使用すると、 ServiceNow およびサードパーティの統合用のカスタム JSON 要求ペイロードを定義および管理できます。
通知ペイロードに追加のフィールドを含めたり、ターゲットシステムで不要な特定のデータを除外したり、特定のサードパーティ API 要件や内部ビジネスロジックに合わせてペイロードをフォーマットしたりできるようになり、顧客側で複雑なスクリプト化された REST API を用意する必要がなくなります。
- デフォルトのペイロードを使用するか、必要に応じてカスタマイズして追加データを含めます。
- 必要に応じて、左側のエディターウィンドウに表示されるデフォルトのペイロードを変更します。
- 各パラメーターはキーと値で構成されているため、キーまたは値、またはその両方を変更します。
- 右側の [プレビュー] セクションには、レンダリング後に予想される JSON ペイロードが表示されます。
- JSON が無効な場合は、エラーが強調表示され、保存するオプションが無効になります。
デフォルトの口ひげペイロードテンプレート
{
"alert_number": "{{alert_number}}",
"alert_type": "{{alert_type}}",
"alert_name": "{{alert_name}}",
"alert_time": "{{alert_time}}",
"instance": "{{instance}}",
"description": "{{description}}",
"alert_created": "{{alert_created}}"
}
例:デフォルトペイロード + カスタムパラメーター
{
"alert_number": "{{alert_number}}",
"alert_type": "{{alert_type}}",
"alert_name": "{{alert_name}}",
"alert_time": "{{alert_time}}",
"instance": "{{instance}}",
"description": "{{description}}",
"alert_created": "{{alert_created}}",
"Custom_message": "{{alert_name}}' of type {{alert_type}} generated for {{instance}} at {{alert_time}}. Please review.",
"Severity": “High”
}
カスタムパラメーターと制限
[custom_parameter] フィールドでは、JSON テンプレートにカスタムメッセージを挿入できます。また、カスタムパラメーターのサンプルに示すように、既存のパラメーターを使用することもできます。
- 必須:テンプレートを保存するための少なくとも 1 つ、最大で 20 のパラメーター。
- 最大:13 個のカスタムパラメーター。
- 超過すると、次の警告が表示されます。 テンプレートには、少なくとも 1 つのデフォルトキーと最大 20 個のキーが必要です。デフォルトを適用するには、[デフォルトにリセット] を調整または選択します。
構文リファレンスのカスタムパラメーターのサンプル
"Information": "{{alert_time}}の{{instance}}に対してアラート{{alert_name}}がトリガーされました。説明:{{description}}"
"Alert_message": "{{alert_type}}タイプの新しいアラート「{{alert_name}}」が{{instance}}の{{instance}}に対して{{alert_time}}で生成されました。確認してください。(Resolution requires field is inconsistent with case priority. Please review.)」
"Event_type": "重大度 - 高! {{alert_name}} が {{instance}} に対して {{alert_time}} でトリガーされました。説明:{{description}}"
サードパーティの要求本文マッピング
一部のサードパーティ統合では、特定のキー名が必要です。デフォルトのペイロードは、想定される形式に合わせて変更できます。
{
"endTime": 1,
"entitySelector": "string",
"eventType": "AVAILABILITY_EVENT",
"properties": {},
"startTime": 1,
"timeout": 1,
"title": "string"
}
サードパーティの形式に合わせて変更された IO ペイロード
アクションと検証
- 変更を元に戻す
- 最後に保存されたコンテンツを復元します。
- デフォルト値にリセット
- テンプレートをデフォルトのペイロードにリセットします。
- シンタックスバリデーター
- 保存する前に JSON の有効性を確認します。エラーにより保存できません。
- テスト統合
- Webhook 統合を検証するためのサンプル通知を送信します。