Webhookイベントフローを構築する

Okta Workflowsを使用すると、Webhookフレームワークをサポートするイベントカードを構築できます。これはリモートシステムで発生したイベントへのほぼリアルタイムのレスポンスを提供します。Webhookイベントの構築方法は、リモートサービスAPIで提供される機能とイベントカードの目標に応じて異なります。

Webhookイベントフローを使用すると、ユーザーの作成、ファイルの削除、不審なアクティビティの報告などのイベントに基づいてトリガーされるコネクター用のカードを構築できます。

Webhookの動作方法の詳細については、Webhookイベントを参照してください。

開始する前に

  • Okta Workflowsにアクセスできるスーパー管理者でなければなりません。

  • コネクターをまだ作成していないときは、次の手順に従って作成します。

    • Okta Workflowsコンソールでコネクタービルダーコンソールのリンクを開きます。

    • コネクタービルダーでアイコンをクリックしてコネクターを作成します。新しいコネクターに一意の名前と有用な説明を付けます。

  • コネクターに、基本的なことからすぐに始めるセクションのタスクで基本的な基盤と認証要素があることを確認してください。

手順

  1. メインパネルで新しいコネクターをクリックして開きます。

  2. フロー（Flows）タブで、新規フロー（+ New Flow）をクリックしてフローを作成します。

  3. イベントを追加（Add event）をクリックし、イベント（Events）の選択肢からWebhookイベント（Webhook Event）を選択します。

  4. オプションを追加（Add Options）をクリックして、Webhookイベント（Webhook Event）カード用に宣言したいオプションを追加します。

  5. Webhook登録（Webhook Registration）（Configure）セクションで 構成（Configure）（Webhook Registration）をクリックしてWebhook登録ダイアログを開きます。

  6. 登録（Registration）ダイアログで、フローを選択（Choose Flow）をクリックして、Webhookイベントの登録および登録解除ヘルパーフローを選択します。ヘルパーフローが存在しない場合は、新規フローを作成（Create new flow）をクリックできます。

    • 登録フロー（Registration Flow）

      ユーザーが、デプロイ済みのWebhookイベントカードを含むフローを有効にすると、登録ヘルパーフローがトリガーされます。

      登録フローでは、ユーザーのフローの一意のイベントURL（Event URL）を外部サービスに登録し、Webhookペイロードの送信先がサービスに認識されるようにします。

      登録ヘルパーフローを選択したら、Webhookイベントカードにあるオプションフィールドを使用して、登録ヘルパーフローに渡す入力フィールドをマッピングできます。これにより、各Webhookカードから異なるオプションを渡すことで、同じ登録ヘルパーフローを複数のWebhookイベントカードに使用できるようになります。

      登録ヘルパーフローには、登録データ（Registration Data）というオブジェクトフィールドがあるリターンカードが含まれています。このオブジェクトは、登録解除フロー（Deregistration Flow）の実行時に必要になる参照を保存するために使用されます。

      Webhookイベントを登録するを参照してください。

    • 登録解除フロー（Deregistration Flow）

      登録フローと同様に、ユーザーが、デプロイ済みのWebhookイベントカードを含むフローを無効にすると、登録解除ヘルパーフローがトリガーされます。

      登録フローから登録データ（Registration Data）出力を使用して定義された情報はすべて、登録解除フロー（Deregistration Flow）イベントカードの入力として使用できます。

      登録解除ヘルパーフローを選択したら、Webhookイベントカードにあるオプションフィールドを使用して、登録解除ヘルパーフローに渡す入力フィールドをマッピングできます。登録ヘルパーフローと同様に、これによって同じ登録解除ヘルパーフローを複数のWebhookイベントカードに使用できるようになります。

      登録解除ヘルパーフローにはリターンカードは含まれていません。

      Webhookイベントの登録を解除するを参照してください。

    • 適用（Apply）をクリックして、登録および登録解除ヘルパーフローとその入力マッピングを確定します。選択した登録または登録解除ヘルパーフローを削除する必要がある場合は、ごみ箱アイコンをクリックします。

  7. 出力を追加（Add Outputs）をクリックして、Webhookイベントフローの出力を返す（Return Outputs）カードを構成します。

  8. オプション（Options）ダイアログでは、Webhookで返したい出力を指定できます。グループを追加（Add group）をクリックして出力グループを作成します。

    1. Webhookペイロードがレコードのリストを返し、このWebhookイベントカードを使用するフローの実行モードを指定したい場合は、実行モードを有効化（Enable Run mode）をアクティブ化します。Webhookの実行モードを有効化するを参照してください。

    2. 静的出力グループ（Static Output Group）ペインで、この出力セットのグループ名（Group Name）を指定します。出力として返したいフィールドごとに、ラベル（Label）を指定し、フィールドタイプ（Field Type）とデータ型（Data Type）をドロップダウンメニューから選択します。プレビューカードにリターンカードがどのように表示されるかが示されます。

    3. グループを追加（Add group）をクリックして別の出力グループを追加します。

  9. 適用（Apply）をクリックして、出力を返す（Return Outputs）カードへの変更を保存します。

  10. ツールバーの保存（Save）ボタンをクリックし、フローに名前を付けます。

次の手順

Webhookイベントフローの既知の問題と制限

フローをテストする

フローをデプロイする