Webhookイベントを登録する

Webhook登録は、システム間の接続を確立し、リアルタイム情報の交換を実現するプロセスです。Webhookの登録とは、基本的には、特定のイベントが発生したときにあるシステムが別のシステムにデータを送信する先となる場所を指定することです。

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

はじめに

  • Okta Workflowsにアクセスできるスーパー管理者である必要があります。

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

    • Okta Workflowsコンソールで［App switcher（アプリスイッチャー）］アイコンをクリックし、次にコネクタービルダーコンソールのリンクをクリックします。

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

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

このタスクを開始する

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

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

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

  4. ［Webhook Registration（Webhookの登録）］カードで、Webhookの登録の入力を定義します。この入力値は次の2つの方法で入力できます。

    • Webhookイベントカードが登録フローを実行するたびに使用される静的テキストとして。

    • Webhookイベントカードから登録フローに渡されるオプションの値として。Webhookイベントカードに登録フローを追加する際には、Webhookイベントのオプションからこのカードの入力に値をマッピングできます。この2番目のオプションでは、同じ登録イベントカードを複数のWebhookイベントカードに使用できます。

    Event URL（イベントURL）は自動生成されるURLです。これはユーザーがこのWebhookイベントを含むフォローを有効にすると作成されます。

  5. 関数カードを使用して外部サービスの構築と呼び出しを行い、Webhookを登録します。

これでこの登録フローをWebhookイベントカード内で参照できるようになります。

リターンカード

リターンカードにはRegistration Data（登録データ）オブジェクトが含まれています。ユーザーが、Webhookイベントを含むフローを無効にすると、登録解除イベントフローがこのオブジェクト内に保存されている情報を参照してWebhookの登録を解除します。たとえば、これは一意の識別子を含むシンプルなオブジェクトである場合があります。

コピー 
{  
  "webhook_id": "99b50e15-8809-47f1"  
}

このオブジェクトは、APIエンドポイント、URL、またはWebhookを登録するために必要な、サービスから返されるその他の情報で構成される場合もあります。「Webhookイベントの登録を解除する」を参照してください。

このフィールドは削除できません。また、リターンカードにその他のフィールドを定義することはできません。