Ticket Orchestrator 用 Webhook プラグイン

このドキュメントでは、Webhook ITSM とNetskope Cloud Exchangeの Ticket Orchestrator モジュールの統合を構成する方法について説明します。 このプラグインは、Webhook をサポートするプラットフォーム上で Webhook を作成するために使用します。 このプラグインは POST メソッドのみを使用します。

前提条件

この設定を完了するには、以下が必要です。

プラグインスコープ

このプラグインは、Netskopeアラートの通知作成をサポートします。

Webhookプラグインのサポート

マッピング

NA

権限

Webhook URLにデータを送信する権限。

パフォーマンスマトリックス

このパフォーマンス測定値は、プラグインを数時間実行した後、1分ごとにランダムに測定値を取得し、Webhookで生成されるチケット数の平均値を収集した後に算出されたものです。測定値は、下記の仕様を満たす大型CEスタックで収集されます。

APIの詳細

プラグインは Webhook URL を使用して、指定された URL への POST リクエストによるデータ送信を実行します。

使うAPI一覧

チケットを作成する

Example

API Endpoint

<URL of your Webhook>

Method

POST

Parameters

None

Data

{"text": "This is a new message.", "unflur_link": true}

API Request Endpoint

<URL of your Webhook>

https://hooks.slack.com/services/T69KXV56W/B05SXH8JTSA/xYE9SZvmwHZh6l4gaL*****C

Sample API Response

ユーザーエージェント

このプラグインに追加されたユーザーエージェントは、以下の形式です。

netskope-ce-<CE VERSION>-<MODULE NAME>-<PLUGIN NAME>-v<PLUGIN VERSION> 

それは次のようになります。

netskope-ce-4.2.0-cto-webhook-v1.0.0

ワークフロー

1. Webhook URLを取得します。
2. Webhookプラグインを設定します。
3. Webhook 用の Ticket Orchestrator ビジネスルールを作成します。
4. Webhook用のチケットオーケストレーターキューを作成します。
5. チケットセクションで確認してください。
6. Webhookアプリ（チャットなど）で検証します。

再生ボタンをクリックして動画をご覧ください。

Webhook URLを取得する

1. Webhook URLを作成するには、 Google Chat > Spacesにアクセスしてください。
2. Space Name .
   をクリックしてください
3. Apps & integrationsをクリックしてください。
4. Add webhooksをクリックしてください。
5. Webhook にNameを入力してSaveをクリックしてください。
6. 3つの点とCopy Linkをクリックし、URLを安全な場所に保存してください。Webhookプラグインを設定するには、これが必要です。

Webhookプラグインを設定する

1. Settings > Plugins. へ移動
2. Webhook プラグインボックスを検索して選択します。（チケットオーケストレーターモジュールが有効になっていることを確認してください。）そうでない場合は、 Settings > Generalに移動してチケットオーケストレーターモジュールを有効にしてください。
3. 構成名を入力してください。
4. 同期間隔を適切な値に調整してください。推奨値は5分以上です。
5. Nextをクリックしてください。
6. Webhook URLを入力してください。形式は次のようになります: https://chat.googleapis.com/v1?/*****。
7. Saveをクリックしてください。

Webhook 用の Ticket Orchestrator ビジネスルールを作成します

Webhookプラグインでチケットを生成するために必要なフィルターに基づいてビジネスルールを作成します。

1. Ticket OrchestratorモジュールでBusiness Rulesを選択します。
2. Create new ruleをクリックしてください。
3. テキストボックスに適切なルール名を入力し、ビジネスルールのフィールドに対して適切なフィルタクエリ条件を作成してください。Filter Queryをクリックしてクエリを手動で入力することもできます。
4. Saveをクリックしてください。
5. 新しく作成したビジネスルールをテストするには、 アイコンをクリックしてTime period (in days),を入力し、 Fetchをクリックします。これにより、インシデント／チケット作成の対象となるアラートの数が表示されます。

Webhook 用の Ticket Orchestrator キューを作成する

1. 1. Ticket OrchestratorでQueuesをクリックします。
   2. Add Queue Configurationをクリックしてください。
   3. ドロップダウンリストから、以前に作成したBusiness RuleをSelect 。
   4. ドロップダウンリストから、キューを設定するプラグインConfiguration Select 。
   5. 通知を受け取るドロップダウンリストからQueues をSelect 。 通知は選択されたWebhookに作成されます。
   6. Map Fieldセクションの下に、アラートとインシデントの間で適切な値を追加/マッピングしてください。アラートの属性には、カスタムメッセージフィールド内の「$」記号を介してアクセスできます。

1. Saveをクリックしてください。
2. ビジネスルールに基づいて、受信アラートに対するWebhook通知が自動的に作成されます。過去のアラートの Webhook 通知を作成するには、ここをクリックしてください。 設定済みのキューで期間（日数）を入力し、 Fetchをクリックします。これにより、チケット作成の対象となるアラートの数が表示されます。これらのアラートのWebhookデータを作成するには、 Sync をクリックしてください。

Webhookプラグインを検証する

Cloud Exchangeで検証する

ワークフローを検証するには、Netskope Alertsが必要です。

1. Webhookで作成されたチケットの一覧を表示するには、チケット Orchestrator メニューのTickets に移動してください。
2. Webhookでチケットが作成されない場合は、Cloud Exchange > Logging の監査ログを確認してください。フィルターを適用: 「エラーに任意の文字を入力してください」。

Webhook対応プラットフォームで検証する

Webhook URL プラットフォーム (Google チャット グループ内) に移動します。

Webhookプラグインのトラブルシューティング

通知を使うプラグインを作成できません

プラグインから通知を共有できない場合、考えられる理由は以下のいずれかです。

• Webhook URLにデータを送信できない場合は、新しいアラートが取得されているかどうかを確認してください。

What to do: 上記の問題が発生している場合は、前述の点が原因である可能性があります。この問題を解決するには、以下の手順をそれぞれ実行してください。

• Webhook URLにデータを送信できない場合。
  1. Netskope CEにアクセスしてください。
  2. 「チケットオーケストレーター」をクリックしてください。
  3. 「アラート」をクリックしてください。
  4. 新しいアラートが表示されているかどうかを確認してください。

Webhookプラグインの制限事項

データをJSON形式に変換する際に、注目すべき制約が1つ生じます。JSON変換内の「区切りリプション」フィールドに二重引用符が含まれている場合、二重引用符を含む動的フィールドが存在するためエラーが発生し、JSONオブジェクトが無効になります。