POSTメソッドを使用したアラートの設定
ウェブフック は、プロセスで何かが起きたときにユーザー、他のアプリケーション、またはITシステムに通知する仕組みです。データをアップロードした後、一部のタイムラインが設定された条件を満たしている場合、アプリケーションは対応する通知を送信します。
ウェブフックの作成に使用できるメソッドのひとつにPOSTがあります。Timelineは新しいHTTP POSTリクエストを作成し、指定されたURLアドレスに送信します。
ウェブフックの作成方法
- をクリックしてアラート編集ウィンドウを開きます。
重要。ウェブフックを作成する前に、アラートを追加して設定する必要があります。手順については、「アラートの作成と実行方法」を参照してください。 - ウェブフックセクションでをクリックします。
- POSTメソッドを選択します。
- ウェブフックのパラメータを設定します。
設定の中には、任意のものもあります。パラメータは下表のとおりです。
パラメータ | 説明 |
---|---|
URL | 情報の送信先となる有効なURL。 |
HTTPベーシック認証 (オプション) |
ウェブフックで認証が必要な場合に使用する有効な認証情報。 認証情報を設定するには:
|
ウェブフック名 | レポートに表示されるウェブフック名。アラートの識別に役立ちます。 |
リクエストヘッダー (オプション) |
POSTリクエストに含まれる追加のHTTPヘッダーとその値。 ヘッダーを追加するには:
|
コンテンツタイプ:マルチパート | タイムラインIDフィールド名 一致したタイムラインIDを含む配列名。 たとえば、条件を満たす3つのタイムラインがあり、そのIDは次の配列を形成します: ["45B87","3A584","C954T3"] |
コンテンツタイプ: JSON |
|
- テストをクリックして、ウェブフックが正しく設定されていることを確認します。
設定されたURLにテスト情報を含むPOSTリクエストが表示されます。 - 保存をクリックします。
コンテンツタイプ
ウェブフックの設定中に、送信するコンテンツを次のように選択できます:
- マルチパート
境界で区切られた異なる部分で構成されているデータ。各パートは個別のエンティティであり、独自のHTTPヘッダーを持っています
注:指定されたイベント属性はマルチパートコンテンツに含まれていません。
送信された文書は2つの部分に分かれています: - ウェブフック名の値。
- 一致したタイムラインのIDを格納する配列。
マルチパートコンテンツの例を表示
- JSON
リクエストには、指定されたイベント属性を持つJSONファイルが含まれます。送信されたデータには以下が含まれます: - ウェブフック名の値。
- 一致したタイムラインのIDを格納する配列。
- 各要素がタイムラインIDと接続された属性を次の形式で含む配列:
[{"id":"TimelineID", "EventName / AttributeName": "AttributeValue"}, {...}] - カスタムプロパティ値。
コメント付きのJSONファイルの例を表示する
JSON構成例
タスク:発生したアラートに関する情報を含むJSONファイルを送信するウェブフックを作成します。
ソリューション:ウェブフックウィンドウで、ポストメソッドを選択し、ウェブフックURLと名前を指定します。コンテンツタイプにJSONを選択します。タイムラインIDが入った配列の名前を設定します。Order IDsなどです。必要に応じてカスタムプロパティを追加します。たとえば、キーフィールドにSourceを入力し、値フィールドにTimelineを入力します。
05.09.2024 16:23:55