プレビュー

このプロダクトまたは機能には、サービス固有の利用規約の「一般的なサービス規約」の「pre-GA サービス規約」が適用されます。 一般提供前のプロダクトと機能は「現状のまま」ご利用いただけますが、サポートが制限される場合があります。 詳しくは、リリース ステージの説明をご覧ください。

Webhook

Webhook コネクタを使用すると、Webhook をサポートするバックエンドからのイベントをリッスンできます。このコネクタは、Webhook トリガーで使用するためのものです。Webhook トリガーは、Webhook イベント機能をサポートするサードパーティの SaaS ベースのアプリケーションからイベントを受信します。このトリガーは、イベント リスナーの複数の認証タイプをサポートしています。統合で Webhook トリガーを使用するには、まず Webhook コネクタを構成する必要があります。

始める前に

Webhook コネクタを使用する前に、次の作業を行います。

• Google Cloud プロジェクトで次の操作を行います。
  • 次のサービスを有効にします。
    • secretmanager.googleapis.com（Secret Manager API）
    • connectors.googleapis.com（Connectors API）

    サービスを有効にする方法については、サービスを有効にするをご覧ください。

  • コネクタに使用するサービス アカウントに、次の IAM ロールを付与します。
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    サービス アカウントは特別なタイプの Google アカウントで、Google API のデータにアクセスして認証を受ける必要がある人間以外のユーザーを表します。サービス アカウントがない場合は、サービス アカウントを作成する必要があります。詳細については、サービス アカウントを作成するをご覧ください。

  以前にプロジェクトでこうしたサービスを有効にしていない場合は、コネクタを構成するときにそれを有効にすることを求められます。

コネクタを構成する

コネクタを構成するには、データソース（バックエンド システム）への接続を作成する必要があります。接続はデータソースに特有です。つまり、多数のデータソースがある場合は、データソースごとに別々の接続を作成する必要があります。接続を作成する手順は次のとおりです。

1. Cloud コンソールで、[Integration Connectors] > [接続] ページに移動し、Google Cloud プロジェクトを選択または作成します。

   [接続] ページに移動

2. [+ 新規作成] をクリックして [接続の作成] ページを開きます。
3. [ロケーション] セクションで、接続のロケーションを選択します。
   1. リージョン: プルダウン リストからロケーションを選択します

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

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

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

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

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

      • 認証なし
      • Google 認証: サービス アカウントに、アクセス トークンが認証に使用される roles/connectors.listener ロールがあることを確認します。
      • API キー認証
      • 基本認証
   2. イベントタイプ フィールドの場所: 受信イベント リクエストに関連付けられたイベントタイプが存在する場所（ヘッダー、クエリ パラメータ、リクエスト本文）を示す必須フィールドです。
   3. イベントタイプのフィールド名: リクエスト本文の必須フィールドで、受信イベント リクエストに関連付けられているイベントのタイプが指定されます。

   {
   "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. [次へ] をクリックします。
6. 確認: 接続とリスナー認証の詳細を確認します。
7. [作成] をクリックします。

統合で Webhook 接続を使用する

接続を作成すると、Apigee Integration と Application Integration の両方で使用できるようになります。この接続は、コネクタタスクを介して統合で使用できます。

• Apigee Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。
• Application Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。

Google Cloud コミュニティの助けを借りる

Google Cloud コミュニティの Cloud フォーラムで質問を投稿したり、このコネクタについてディスカッションしたりできます。

次のステップ

• 接続を一時停止して再開する方法を確認する。
• コネクタの使用状況をモニタリングする方法を確認する。
• コネクタログを表示する方法を確認する。