通知用Webhookの作成

オンラインで編集

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

このタスクについて

開始したい外部APIのリクエスト（ URL ）を設定し、リクエスト（ URL ）を開始するために必要なヘッダーやパラメータを追加できます。 イベントのペイロードに関する詳細については、 「イベントの種類とペイロード」 を参照してください。

Webhookの設定JSONには、`property notification `というプロパティが存在します。 このプロパティーはネストされた JSON オブジェクトで、通知固有の構成オプションをすべて含んでいます。 interests プロパティーは、この notification オブジェクト内で定義されます。 イベントが発生すると、interests プロパティー内の各エレメントに対してイベントが検査されます。 プロパティ interests 内のいずれかの要素が一致すると判定された場合、そのイベントはWebhookの送信先に送信されます。 関心事項は順番にチェックされるため、高性能が求められるユースケースでは、最も範囲の広いものを最初に配置してください。

関心事項は 2 つのフィールド (分かりやすいname と clauses のリスト) で構成されます。 これらの条項によって、その利害関係が一致するか否かが決まります。 各節は演算 AND 子によって結合されており、すべての節が条件を満たした場合にのみ、条件が成立する。 節は、以下の 3 つのフィールドで構成されます。

  • key
  • value
  • excludeoperation - 有効な値は および です include 。
キーはJSONのプロパティ名であり、この句が一致するかどうかを判断するために、イベント内のどの位置を指すかを指定するために使用されます。 このキーを使用すると、イベントのトップレベルキーや、イベントのデータオブジェクト内のキーを評価することができます。 data.actionデータオブジェクトを参照する際は、JSONドット表記が使用されます。例えば、. この値は、検査対象のフィールドの期待値です。 この演算子は、この句に一致した場合、そのイベントを含めるか除外するかを示します。

たとえば、認証イベントが主な関心事であるものの、フェデレーションを介して行われる認証を除外したい場合は、以下の句を使用します：

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

これらの節は、論理評価として次のように表されます：

federationevent_type ～であり authentication 、 data.subtype ～ではない。

詳細については、 「通知 Webhook」 を参照してください。

手順

  1. 「統合 」>「 通知 Webhook」 に移動します。
  2. 「Webhookを作成」 をクリックします。
  3. Webhook の名前を指定します。
    所有者および E メールの連絡先情報を指定することもできます。
  4. API の 1 つ以上の要求 URL を指定します。
  5. 認証のタイプを選択します。
    基本
    ユーザー名とパスワードを指定します。
    見出し
    ヘッダー名と認証シークレットを指定します。 シークレットに大/小文字の区別がある場合は、区別のチェック・ボックスを選択します。
    なし
    認証情報は必要ありません。
    OAuth
    トークン・エンドポイントを指定し、クライアント・シークレットが post であるか basic であるかを選択し、クライアント ID とシークレットを入力します。
    注： クライアントの投稿によると、シークレットは属性として保存されているとのことです。 クライアント basic は、シークレットがヘッダーに保管されることを示します。
    JSON Web トークン (JWT)
    HTTP ヘッダーの値、サブクレーム、JWTの最大有効期間、および署名アルゴリズムを指定します。 必要に応じて、JWTヘッダー値のプレフィックス、JWTヘッダーキー、およびクレーム名を指定することもできます。
    Mutual TLS ( mTLS )
    MTLS証明書のラベルを指定してください。
  6. 任意： 任意のカスタムヘッダーと値を入力してください。
  7. オプション： デッドレター機能を有効にする。
    「未達メール」には、配信に失敗した通知が記録されます。
    1. 「デッドレターの照合を自動的に試行する」 を有効にし、照合の試行間隔を選択します。
      通知を5分、15分、または30分ごとに再送信するように設定できます。
  8. 「次へ」をクリックします。
  9. Webhookのイベント登録を指定してください。
    指定したイベントのいずれかが発生すると、Webhookに対して通知が送信されます。 定義済みのイベントを選択するか、カスタムイベントを追加してください。 少なくとも1つのイベントを指定する必要があります。
  10. （任意） 「事前定義されたイベント 」をクリックします。
    1. あらかじめ定義されたイベントのうち、1つ以上を選択してください。
      • すべての認証イベント
      • 失敗した認証イベント
      • ユーザー・プロファイルが変更されました
      • 作成されたユーザー・プロファイル
      選択したイベントは、「 選択したイベント 」の詳細ペインに一覧表示されます。
    2. 「追加」 をクリックします。
      イベントの登録ページに戻り、 「イベントの設定 」セクションにイベントが一覧表示されます。
  11. （任意）： 「カスタムイベントを追加 」をクリックします。
    1. イベントの名前を入力してください。
      イベントの説明を指定することもできます。
    2. イベントをトリガーする関心事を指定してください。
      イベントとは、イベントを発生させるには真と評価される必要があるプロパティと値のペアです。
    3. 利息を含めるか除外するかを指定してください。
      「include」と user.type admin 「exclude」を指定 event_type authentication することで、管理者によるものではないすべての認証イベントに対してWebhookをトリガーするように設定できます。
    4. 任意： さらに興味のある分野を指定してください。
  12. 「追加」 をクリックします。
    イベント登録ページに戻り、そのイベントが 「イベント設定 」セクションに表示されます。
  13. （任意）： さらにカスタムイベントを追加します。
  14. 「作成」 をクリックします。
    Webhookは「 通知Webhook 」ページに一覧表示され、そのWebhookが表示されます。
  15. （任意）： Webhookのイベントを変更します。
    1. カスタムイベントや定義済みイベントを追加します。
    2. イベントを編集する
      1. 編集アイコン変更したいイベントを選択し、鉛筆アイコンをクリックしてください。
      2. 名前や説明を変更できます。 興味・関心事項を追加または変更できます。
      3. 「更新」 をクリックしてください。
    3. 丸で囲まれたマイナス記号イベントを削除するには、そのイベントを選択し、 [削除 ] アイコンをクリックします。
  16. （任意）： 接続情報を変更します。
    1. 「接続の詳細」 を選択します。
    2. 「目的 」と「 統合バージョン」 以外のすべての設定を変更してください。
    3. 接続をテストします。
    4. 健康状態を確認する。
    5. Webhookを削除します。
  17. 変更を加えた場合は、 「変更を保存」 をクリックしてください。
  18. 「通知 Webhook」 をクリックして、 「通知 Webhook 」ページに戻ります。