Webhook

Webhook 連接器可讓您監聽支援 Webhook 的後端事件。此連接器專為搭配Webhook 觸發條件使用。Webhook 觸發條件會接收來自支援 Webhook 事件功能的第三方 SaaS 應用程式事件。這個觸發條件支援事件監聽器的多種驗證類型。如要在整合中使用 Webhook 觸發事件，您必須先設定 Webhook 連接器。

事前準備

使用 Webhook 連接器前，請先完成下列工作：

  • 在 Google Cloud 專案中：
    • 啟用下列服務：
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (連接器 API)

      如要瞭解如何啟用服務，請參閱「啟用服務」。

    • 將下列 IAM 角色授予要用於連接器的服務帳戶：
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      服務帳戶是特殊的 Google 帳戶類型，主要用於代表需要驗證且必須取得授權才能存取 Google API 資料的非人類使用者。如果您沒有服務帳戶，請務必建立服務帳戶。詳情請參閱「建立服務帳戶」。

    如果先前未為專案啟用這些服務或權限，系統會在設定連接器時提示您啟用。

設定連接器

連線是特定資料來源的連線，也就是說，如果您有多個資料來源，則必須為每個資料來源建立個別的連線。如要建立連線，請按照下列步驟操作：

  1. 在 Cloud 控制台中，前往「Integration Connectors」 >「Connections」頁面，然後選取或建立 Google Cloud 專案。

    前往「連線」頁面

  2. 按一下「+ 建立新連線」，開啟「建立連線」頁面。
  3. 在「位置」部分，選擇連線的位置。
    1. 區域：從下拉式清單中選取位置。

      如需所有支援地區的清單，請參閱「位置」一節。

    2. 點按「Next」。
  4. 在「連線詳細資料」部分中，完成下列操作：
    1. 連接器：從可用連接器的下拉式清單中選取「Webhook」。
    2. 連接器版本：從可用版本的下拉式清單中選取連接器版本。
    3. 連線名稱：輸入連線執行個體的名稱。

      連線名稱必須符合下列條件：

      • 連線名稱可以包含英文字母、數字或連字號。
      • 字母必須為小寫。
      • 連線名稱的開頭必須為英文字母，結尾則須為英文字母或數字。
      • 連結名稱不得超過 49 個半形字元。
      • 對於支援事件訂閱功能的連接器，連線名稱開頭不得為「goog」前置字串。
    4. 說明：視需要輸入連線例項的說明。
    5. 服務帳戶：選取具備必要角色的服務帳戶。
    6. 事件訂閱：系統預設會啟用事件訂閱，且這是 webhook 連接器的必要條件。
    7. 您可以按一下「+ 新增標籤」，以鍵/值組合的形式為連線新增標籤。
    8. 點按「Next」。
  5. 在「事件訂閱項目詳細資料」部分中，完成下列操作：
    1. 事件監聽器驗證：選取事件監聽器的驗證類型，然後輸入相關詳細資料。

      Webhook 事件監聽器支援下列驗證類型：

    2. 事件類型欄位位置：這個必要欄位會指出與傳入事件要求相關聯的事件類型所在位置 (標頭、查詢參數或要求本文)。
    3. 事件類型欄位名稱：設定位置中的必要欄位，可識別與傳入事件要求相關聯的事件類型。
      4. {
"event_type": "user.created",
...
// other request fields
...
}
       在上例中，「要求主體」中的 event_type 欄位表示要求與「user.created」事件相關。
    4. 選取「Enable private connectivity」，即可在後端應用程式和連線之間建立安全連線。如果選取這個選項，您必須在建立連線後執行其他設定步驟。詳情請參閱「事件訂閱的私人連線」。
    5. 輸入死信設定。如果您設定無效信件，連線會將未處理的事件寫入指定的 Pub/Sub 主題。輸入下列詳細資料：
      1. 死信專案 ID： 您設定死信 Pub/Sub 主題的 Google Cloud 專案 ID。
      2. 無效信件主題： 您要寫入未處理事件詳細資料的 Pub/Sub 主題。
    6. 點按「Next」。
  6. 查看：查看連線和聽眾驗證詳細資料。
  7. 按一下 [建立]。

在整合中使用 Webhook 連線

建立連線後，即可在 Apigee Integration 和 Application Integration 中使用。您可以透過「連接器」工作，在整合中使用連線。

  • 如要瞭解如何在 Apigee Integration 中建立及使用連接器工作，請參閱「連接器工作」。
  • 如要瞭解如何在 Application Integration 中建立及使用連接器工作，請參閱「連接器工作」。

向 Google Cloud 社群尋求協助

如有任何問題，歡迎在 Cloud 論壇中發問並討論這個連接器。

後續步驟