通知 Webhook の作成

通知 Webhook は、特定のイベントが発生したときにサード・パーティーにデータを送信するために使用する外部 API 呼び出しです。

このタスクについて

開始したい外部 API のURLを設定し、 URLの開始に必要なヘッダーパラメータを追加することができます。イベントペイロードに関する情報は、「イベントタイプとペイロード」を参照してください。

Webhook 構成 JSON 内に、プロパティー notification が存在します。このプロパティーはネストされた JSON オブジェクトで、通知固有の構成オプションをすべて含んでいます。 interests プロパティーは、この notification オブジェクト内で定義されます。イベントが発生すると、interests プロパティー内の各エレメントに対してイベントが検査されます。 interests プロパティー内のいずれかのエレメントが一致と評価されると、イベントは Webhook 宛先に送信されます。関心事は順番にチェックされるため、高性能なユース・ケースでは、最も広範囲のマッチを最初にします。

関心事項は 2 つのフィールド (分かりやすいname と clauses のリスト) で構成されます。これらの節は、インタレストが一致するかどうかを決定します。文節は AND 操作と結合され、すべての文節がインタレストと一致する場合にのみ満たされます。節は、以下の 3 つのフィールドで構成されます。

key
value
operation -有効な値は include および excludeです。

キーは JSON プロパティー名であり、この節が一致するかどうかを判別するためにイベント内の場所を示すために使用されます。このキーは、イベントのデータ・オブジェクト内の最上位キーまたはキーを評価するために使用できます。データ・オブジェクトを参照する場合は、JSON ドット表記が使用されます (例: data.action)。値は、検査対象のフィールドの予期される値です。この操作は、この節の一致によってイベントが包含または除外されるかどうかを示します。

例えば、認証イベントが重要な関心事であるが、連携によって発生する認証をフィルターで除外する場合は、以下の節を使用します。

Key: event_type, Value: authentication, Operation: include
Key: data.subtype, Value: federation, Operation: exclude

これらの文節は、論理評価になります。

event_type IS authentication AND data.subtype IS NOT federation。

詳細については、通知ウェブフックを参照してください。

手順

[統合 ] > [通知 Webhook] に移動します。
「Webhook の作成」をクリックします。
Webhook の名前を指定します。
所有者および E メールの連絡先情報を指定することもできます。
API の 1 つ以上の要求 URL を指定します。
認証のタイプを選択します。

基本

ユーザー名とパスワードを指定します。

見出し

ヘッダー名と認証シークレットを指定します。シークレットに大/小文字の区別がある場合は、区別のチェック・ボックスを選択します。

なし

認証情報は必要ありません。

OAuth

トークン・エンドポイントを指定し、クライアント・シークレットが post であるか basic であるかを選択し、クライアント ID とシークレットを入力します。
注: クライアント POST は、シークレットが属性として保管されていることを示します。クライアント basic は、シークレットがヘッダーに保管されることを示します。

JSON Web トークン (JWT)

HTTP、サブクレーム、JWTの有効期間、署名アルゴリズムを指定します。必要に応じて、JWT ヘッダー値接頭部、JWT ヘッダー・キー、およびクレーム名を指定することもできます。

相互 TLS (mTLS)

MTLS 証明書ラベルを指定します。
オプション： 任意のカスタムヘッダーと値を入力してください。
オプション: デッドレターを有効にする。
デッド・レター機能は、失敗した通知を記録します。
1. 「送達不能調整を自動的に試行する」を有効にして、試行調整間隔を選択します。
  通知を 5 分ごと、15 分ごと、または 30 分ごとに再送するように指定できます。
「次へ」をクリックします。
Webhook のイベント・サブスクリプションを指定します。
指定したイベントのいずれかが発生すると、Webhook の通知がトリガーされます。事前定義イベントを選択するか、カスタム・イベントを追加します。少なくとも 1 つのイベントを指定する必要があります。
オプション: 事前定義済みイベントをクリックします。
1. 1 つ以上の事前定義イベントのチェック・ボックスを選択します。
  - すべての認証イベント
  - 失敗した認証イベント
  - ユーザー・プロファイルが変更されました
  - 作成されたユーザー・プロファイル
  選択したイベントは、「選択されたイベント」の「詳細」ペインにリストされます。
2. 「追加」をクリックします。
  「イベント・サブスクリプション」ページに戻り、「イベント構成」セクションにイベントがリストされます。
オプション: [カスタムイベントを追加 ] をクリックします。
1. イベントの名前を指定します。
  イベントの説明を指定することもできます。
2. イベントをトリガーするインタレストを指定します。
  イベントは、イベントをトリガーするために true と評価される必要があるプロパティーと値のペアです。
3. インタレストを含めるか除外するかを指定します。
  event_type authentication include および user.type admin exclude を指定して、admin 以外のすべての認証イベントで Webhook をトリガーすることができます。
4. 任意： さらに興味を指定してください。
「追加」をクリックします。
「イベント・サブスクリプション」ページに戻り、「イベント構成」セクションにイベントがリストされます。
オプション: さらにカスタムイベントを追加する。
「作成」をクリックします。
Web フックが「通知 Web フック」ページにリストされ、Web フックが表示されます。
オプション: Webhookのイベントを変更する。
1. カスタム・イベントおよび事前定義イベントをさらに追加します。
2. イベントの編集
  1. 変更したいイベントを選択し、鉛筆アイコンをクリックしてください。
  2. 名前または説明を変更できます。買い物候補を追加または変更できます。
  3. 「更新」をクリックします。
3. イベントを削除するには、そのイベントを選択し、削除アイコンをクリックします。
オプション: 接続の詳細を変更する。
1. 「接続の詳細」を選択します。
2. 「目的」および「統合バージョン」を除くすべての設定を変更します。
3. 接続をテストします。
4. 正常性状況を表示します。
5. Webhook を削除します。
変更を行った場合は、「変更の保存」をクリックします。
「通知 Webhook」ページに戻るには、「通知 Webhook」をクリックします。