Webhookリスナーの構成
マイクロアプリでほぼリアルタイムのデータをエンドユーザーに提供できるように、Webhookリスナー（HTTPプッシュAPIとも呼ばれる）を構成します。Webhookを構成して、マイクロアプリプラットフォーム側からの同期よりもはるかに速い速度で、アプリから他のアプリケーションにデータを配信できます。MAサーバーで処理できるWebhook要求本文の最大サイズは64KBです。
Webhookリスナーを追加するには、ターゲットアプリケーションのレコードシステムを熟知し、それらの場所でWebhookを構成するために必要なツールと管理者権限が設定されている必要があります。
データ読み込みにより統合を設定した後、Webhookを構成し、次の手順に従います：
-
HTTP統合画面の左側のバーにある ［Webhookリスナー］ をクリックします：
- 必要なWebhook名を入力します。
- ［コピー］ を選択して、ターゲットのレコードシステム管理インターフェイスで使用するWebhook URLをコピーします。
承認方法
承認方法を構成する際、［トークン］ 認証方法か ［なし］ のいずれかを選択できます。トークンの方法を構成するには、次の手順に従います：
- 認証方法のメニューで ［トークン］ を選択します。
- ［トークンの生成］ を選択してから ［コピー］ を選択し、ターゲットのレコードシステム管理インターフェイスで使用するためにトークンをクリップボードに追加します。
-
［トークンの読み取り元］ を選択して、次から選択します：
- カスタムヘッダー
- クエリパラメーター
- 認証ヘッダー
- 選択した読み取り方法に応じて、［名前］ または ［プレフィックス］ を定義します。
これでトークンが設定されました。
要求メソッド
Webhookリスナーを構成するときは、次の定義を使用して呼び出しを作成します：
- PUTは、既存のリソースを更新するために使用されます。
- POSTは、新しい従属リソースを作成するため、POSTメソッドを使用してリソースのコレクションに新しいリソースを作成します。 PUTとPOSTはどちらも、ルートテーブルのプライマリキー情報を使用して子テーブルからデータを削除します。次に、既存のレコードを置き換えるか、新しいレコードを挿入します。
-
DELETEは、リソースを削除するために使用されます。
DELETEには2つのエンドポイントがあります：
-
{serviceUuid}/{webhookListenerUuid}/{recordId}ここでrecordIdは、削除するルートテーブルのレコードのプライマリキーの値です。子テーブルのレコードはそれに応じて削除されます。 -
{serviceUuid}/{webhookListenerUuid}/?id1=1&id2=1ここで、id1とid2は、削除するルートテーブル内のレコードの複合プライマリキーの値を表します。子テーブルのレコードはそれに応じて削除されます。
-
- PATCH要求は、リソースを部分的に更新するために使用されます。
データ構造の定義
データ構造は、データ読み込み構成中のデータ構造の取得で説明したのと同様の方法で定義できます。詳しくは、「統合の構成」を参照してください。
Webhookデータ構造を定義するには、次の手順に従います：
- 必要なデータ保持期間を設定します。この日付より古いエントリはすべて削除されます。保存された各エントリには、変更の日付と時刻が含まれています。これは
lastModifiedです。この日付と時刻は、削除するエントリを決定するときに使用されます。 -
［テーブルの生成］ を選択します。
［テーブルの生成］ 画面が開きます。
ターゲットアプリケーションのレコードシステムからのJSONサンプルリクエストをここに貼り付けます。
- 作成したテーブルのベース名を設定します。
- （オプション）必要に応じてルートパスを設定します。
- ［生成］ を選択します。
このプロセスが、ターゲットアプリケーションのレコードシステム管理で入力した構成手段とともに完了したら、［追加］ を選択します。
これでWebhookが構成されました。
スクリプトのサポート
Webhookリスナーでは、HTTP統合スクリプティング機能で構成されたカスタムスクリプトがサポートされています。
独自のスクリプトの開発と実行に関するその他の情報については、Citrix Developerポータルを参照してください。
Webhookログの表示
Webhookログを使用して、すべてのWebhookエンドポイントからの要求とエラーの履歴を表示します。成功、エラー、またはすべてなど、Webhook名と状態で絞り込むことができます。パフォーマンスの目的で、最新の10個のWebhookログエントリのみがWebhookログ画面で確認できるように保持されます。
- ［マイクロアプリの管理］ページから、統合ログを表示する統合の横のメニューを選択します。
- Webhookログを選択します。
- エントリを確認し、メニューから選択して必要に応じて絞り込みます。