Webhook
Webhook 連接器可讓您監聽支援 Webhook 的後端事件。這個連接器是專為Webhook 觸發條件設計,Webhook 觸發條件會接收來自第三方 SaaS 應用程式的事件,這些應用程式支援 Webhook 事件功能。這個觸發條件支援事件監聽器的多種驗證類型。如要在整合作業中使用 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 資料的非人類使用者。如果您沒有服務帳戶,請建立服務帳戶。連接器和服務帳戶必須屬於同一個專案。詳情請參閱「建立服務帳戶」。
如果專案先前未啟用這些服務或權限,系統會在設定連結器時提示您啟用。
- 啟用下列服務:
設定連接器
連線專屬於資料來源。也就是說,如果您有多個資料來源,則必須為每個資料來源建立個別的連線。如要建立連線,請按照下列步驟操作:
- 在 Cloud 控制台中,前往「Integration Connectors」>「Connections」頁面,然後選取或建立 Google Cloud 專案。
- 按一下「+ 建立新連線」,開啟「建立連線」頁面。
- 在「位置」部分中,選擇連線位置。
- 區域:從下拉式清單中選取位置。
如需所有支援的地區清單,請參閱「位置」。
- 點選「下一步」。
- 區域:從下拉式清單中選取位置。
- 在「連線詳細資料」部分,完成下列步驟:
- 連接器:從可用連接器的下拉式清單中選取「Webhook」。
- 連接器版本:從可用版本的下拉式清單中選取連接器版本。
- 連線名稱:輸入連線執行個體的名稱。
連線名稱必須符合下列條件:
- 連線名稱可使用英文字母、數字或連字號。
- 字母必須為小寫。
- 連線名稱開頭須為英文字母,結尾則須為英文字母或數字。
- 連結名稱不得超過 49 個字元。
- 如果連接器支援事件訂閱,連接名稱開頭不得為「goog」前置字串。
- 說明:視需要輸入連線執行個體的說明。
- 服務帳戶:選取具備必要角色的服務帳戶。
- 事件訂閱:系統預設會啟用事件訂閱,且這是 Webhook 連接器必備的設定。
- (選用) 按一下「+ 新增標籤」,以鍵/值組合的形式為連線新增標籤。
- 點選「下一步」。
-
在「Event Subscription Details」(事件訂閱詳細資料) 部分,完成下列步驟:
- 監聽器驗證:選取事件監聽器的驗證類型,然後輸入相關詳細資料。
Webhook 監聽器支援下列驗證類型:
- 無驗證
- Google 驗證:確認服務帳戶具有 roles/connectors.listener 角色,其存取權杖用於驗證。
- API 金鑰驗證
- 基本驗證
- 事件類型欄位位置:這個必填欄位會標示與傳入事件要求相關聯的事件類型所在位置 (標頭、查詢參數或要求主體)。
- 事件類型欄位名稱:已設定位置中的必填欄位,可識別與傳入事件要求相關聯的事件類型。
- 選取「啟用私人連線」,在後端應用程式和連線之間建立安全連線。如果選取這個選項,您必須在建立連線後執行額外設定步驟。詳情請參閱「活動訂閱的私人連線」。
- 輸入無法傳送郵件的設定。如果設定無效信件,連線會將未處理的事件寫入指定的 Pub/Sub 主題。輸入下列詳細資料:
- 無法傳送郵件的專案 ID: 您已設定無法傳送郵件的 Pub/Sub 主題的 Google Cloud 專案 ID。
- 無效信件主題: 要寫入未處理事件詳細資料的 Pub/Sub 主題。
- 點選「下一步」。
在上述範例中,「要求主體」中的 event_type 欄位表示要求與「user.created」事件有關。{ "event_type": "user.created", ... // other request fields ... }
- 監聽器驗證:選取事件監聽器的驗證類型,然後輸入相關詳細資料。
- 查看:查看連線和接聽程式驗證詳細資料。
- 點選「建立」。
在整合中採用 Webhook 連線
建立連線後,Apigee Integration 和 Application Integration 都會提供該連線。您可以在整合中透過「連接器」工作使用連線。
- 如要瞭解如何在 Apigee Integration 中建立及使用「連線器」工作,請參閱「連線器工作」。
- 如要瞭解如何在 Application Integration 中建立及使用連線器工作,請參閱「連線器工作」。