Application Integration でサポートされているコネクタをご覧ください。

Webhook トリガー

Webhook トリガーは、Webhook をサポートするバックエンドからのイベントに基づいて統合を呼び出すことができるコネクタ イベント トリガーです。Webhook トリガーは、Webhook イベント機能をサポートするサードパーティの SaaS ベースのアプリケーションからイベントを受信します。このトリガーは、イベント リスナーに対して複数の認証タイプをサポートしています。

準備

Webhook トリガーの新しい接続を作成または構成する場合は、プロジェクトに対する次の Identity and Access Management（IAM）ロールがあることを確認してください。

  • コネクタ管理者（roles/connectors.admin）

    • ロールの付与については、アクセスの管理をご覧ください。

Webhook トリガーに使用するサービス アカウントに、次の IAM ロールを付与します。

Webhook トリガーを追加する

統合に Webhook トリガーを追加する手順は次のとおりです。

  1. Google Cloud コンソールで [Application Integration] ページに移動します。

    Application Integration に移動

  2. ナビゲーション メニューで [統合] をクリックします。

    [統合リスト] ページが開き、Google Cloud プロジェクトで使用可能なすべての統合が一覧表示されます。

  3. 既存の統合を選択するか、[統合の作成] をクリックして新しい統合を作成します。

    新しい統合を作成する場合:

    1. [統合の作成] ペインで名前と説明を入力します。
    2. 統合のリージョンを選択します。
    3. 統合用のサービス アカウントを選択します。統合のサービス アカウントの詳細は、統合ツールバーの [統合の概要] ペインでいつでも変更または更新できます。
    4. [作成] をクリックします。

    統合エディタで統合が開きます。

  4. 統合エディタのナビゲーション バーで、[トリガー] をクリックして、使用可能なトリガーのリストを表示します。
  5. 統合エディタで、Webhook トリガー要素をクリックして配置します。

    6. Webhook トリガーを構成するには、Integration Connectors で使用可能な既存の Webhook 接続を使用するか、インライン接続作成オプションを使用して新しい Webhook 接続を作成します。

既存の接続を使用して Webhook トリガーを構成する

Integration Connectors の既存の Webhook 接続を使用して、Webhook トリガーを構成できます。なお、Webhook トリガーはコネクタ イベント トリガーであるため、トリガーの構成にはイベント サブスクリプションを有効にした Webhook 接続のみが使用できます。

新しい Webhook 接続を使用して Webhook トリガーを構成する方法については、新しい接続を使用して Webhook トリガーを構成するをご覧ください。

既存の Webhook 接続を使用して Webhook トリガーを構成するには、次の手順を行います。

  1. 統合エディタの Webhook トリガー要素をクリックして、トリガー構成ペインを開きます。
  2. [トリガーの構成] をクリックします。
  3. [Connector Event Trigger Editor] ページで、構成の詳細を次のとおりに入力します。
    1. リージョン: Webhook 接続のリージョンを選択します。
    2. 接続: 使用する Webhook 接続を選択します。

      Application Integration には、アクティブなイベント サブスクリプションが有効になっている Webhook 接続のみが表示されます。

    3. イベント サブスクリプション タイプ: 統合のトリガーに使用するイベントのタイプを入力します。
    4. サービス アカウント: Webhook トリガーに必要な必要な IAM ロールを持つサービス アカウントを選択します。
  4. [Done] をクリックしてトリガーの構成を完了し、ページを閉じます。
詳細については、Webhook 接続ドキュメントをご覧ください。

新しい接続を使用して Webhook トリガーを構成する

新しい Webhook 接続を使用して Webhook トリガーを構成するには、次の手順を行います。

  1. 統合エディタの Webhook トリガー要素をクリックして、トリガー構成ペインを開きます。
  2. [トリガーの構成] をクリックします。
  3. [リージョン] フィールドはスキップします。
  4. [接続] をクリックし、メニューから [接続の作成] オプションを選択します。
  5. [接続の作成] ペインで次の手順を行います。
    1. [ロケーション] セクションで、接続のロケーションを選択します。
      1. リージョン: リストからロケーションを選択します。

        コネクタをサポートしているリージョンは次のとおりです。

        サポートされているすべてのリージョンの一覧については、ロケーションをご覧ください。

      2. [次へ] をクリックします。
    2. [接続の詳細] セクションで、次の操作を行います。
      1. コネクタ: 使用可能なコネクタのプルダウン リストから [Webhook] を選択します。
      2. コネクタのバージョン: 使用可能なバージョンのプルダウン リストからコネクタのバージョンを選択します。
      3. 接続名: 接続インスタンスの名前を入力します。

        接続名は次の条件を満たす必要があります。

        • 接続名には英字、数字、ハイフンを使用できます。
        • 文字は小文字のみを使用できます。
        • 接続名の先頭には英字を設定し、末尾には英字または数字を設定する必要があります。
        • 接続名は 63 文字以内で指定してください。
      4. 説明: 必要に応じて、接続インスタンスの説明を入力します。
      5. サービス アカウント: 必要なロールを持つサービス アカウントを選択します。
      6. イベント サブスクリプション: イベント サブスクリプションはデフォルトで有効になり、Webhook コネクタには必須です。
      7. 必要に応じて、[+ ラベルを追加] をクリックして Key-Value ペアの形式でラベルを接続に追加します。
      8. [次へ] をクリックします。
    3. [イベント サブスクリプションの詳細] セクションで、次の操作を行います。
      1. リスナー認証: イベント リスナーの認証タイプを選択し、関連する詳細を入力します。

        Webhook リスナーでサポートされる認証タイプは、次のとおりです。

      2. イベントタイプ フィールドの場所: 受信イベント リクエストに関連付けられたイベントタイプが存在する場所（ヘッダー、クエリ パラメータ、リクエスト本文）を示す必須フィールドです。
      3. イベントタイプのフィールド名: リクエスト本文の必須フィールドで、受信イベント リクエストに関連付けられているイベントのタイプが指定されます。
        4. {
"event_type": "user.created",
...
// other request fields
...
}
         上の例では、event_typeの event_type フィールドは、リクエストが「user.created」イベントに関連することを示しています。
      4. バックエンド アプリケーションと接続間を安全に接続するには、[プライベート接続を有効にする] を選択します。このオプションを選択した場合は、接続の作成後に追加の構成手順を実行する必要があります。詳細については、イベント サブスクリプションのプライベート接続をご覧ください。
      5. デッドレター構成を入力します。デッドレターを構成すると、指定された Pub/Sub トピックに未処理のイベントが書き込まれます。次の詳細情報を入力します。
        1. デッドレター プロジェクト ID: デッドレター Pub/Sub トピックを構成した Google Cloud プロジェクト ID。
        2. デッドレター トピック: 未処理イベントの詳細を書き込む Pub/Sub トピック。
      6. [次へ] をクリックします。
    4. 確認: 接続とリスナー認証の詳細を確認します。
    5. [作成] をクリックします。

トリガー出力

Webhook トリガーがイベント サブスクリプションの構成を完了するまでに数分かかります。イベント サブスクリプションのステータスは、トリガー構成ペインの [Event Subscription details] で確認できます。

Webhook トリガーは、次の状態を使用して、イベント サブスクリプションのステータスを示します。

  • Creating: トリガーがイベント サブスクリプションに登録中であることを示します。
  • Active: トリガーがイベント サブスクリプションに正常に登録されたことを示します。
  • Error: 構成されたイベント サブスクリプションに問題があることを示します。

[Event Subscription details] セクションには、イベント サブスクリプションのステータスに加えて、接続リージョン、接続名、イベント サブスクリプション名などの詳細が表示されます。

トリガー出力変数

イベントごとに、Webhook トリガーによりダウンストリーム タスクで使用できる ConnectorEventPayload 出力変数が生成されます。出力変数は、出力 Webhook ペイロード スキーマを含む JSON 形式です。

イベント サブスクリプションを表示する

Integration Connectors で接続に関連付けられているすべてのイベント サブスクリプションの表示と管理を行う手順は、次のとおりです。

  1. [Integration Connectors] > [接続] ページに移動します。

    [接続] ページに移動

  2. サブスクリプションを表示する接続をクリックします。
  3. [イベント サブスクリプション] タブをクリックします。

    ここでは、接続のすべてのサブスクリプションが表示されます。

Webhook トリガーを編集する

Webhook トリガーを編集して、接続構成とイベント サブスクリプションの詳細を変更または更新できます。

Webhook トリガーを編集するには、次の手順を行います。

  1. 統合エディタの Webhook トリガー要素をクリックして、トリガー構成ペインを開きます。
  2. [Webhook トリガーの構成] をクリックします。
  3. [Connector Event Trigger Editor] ページで、次の操作を行います。
    1. 構成済みのイベント サブスクリプションを保持するには、[保持] をクリックします。それ以外の場合は、[削除] をクリックします。
    2. 必要に応じて、接続構成とイベント サブスクリプションの詳細を更新します。
    3. [完了] をクリックします。

    4. 更新された接続とイベント サブスクリプションの詳細は、トリガー構成ペインの [Event Subscription details] で確認できます。

割り当てと上限

割り当てと上限については、割り当てと上限をご覧ください。

次のステップ