查看 Application Integration 支援的連接器。

Webhook 觸發條件

Webhook 觸發程序是連接器事件觸發程序，可讓您根據支援 Webhook 的後端事件叫用整合。Webhook 觸發條件會接收來自第三方 SaaS 應用程式的事件，這些應用程式支援 Webhook 事件功能。這個觸發條件支援事件監聽器的多種驗證類型。

事前準備

如要為 Webhook 觸發條件建立或設定新連線，請確認您在專案中具備下列 Identity and Access Management (IAM) 角色：

  • 連接器管理員 (roles/connectors.admin)

    • 如要瞭解如何授予角色，請參閱「管理存取權」。

將下列 IAM 角色授予要用於 Webhook 觸發程序的服務帳戶：

  • Application Integration 叫用者 (roles/integrations.integrationInvoker)

    • 如要瞭解如何將角色授予服務帳戶，請參閱「管理服務帳戶的存取權」一文。

新增 Webhook 觸發條件

如要將 Webhook 觸發條件新增至整合，請按照下列步驟操作：

  1. 前往 Google Cloud 控制台的「Application Integration」頁面。

    前往「Application Integration」

  2. 在導覽選單中，按一下「整合」

    系統隨即會顯示「整合清單」頁面，列出 Google Cloud 專案中可用的所有整合功能。

  3. 選取現有整合，或按一下「建立整合」建立新整合。

    如要建立新的整合項目：

    1. 在「建立整合」窗格中輸入名稱和說明。
    2. 選取整合作業的區域。
    3. 選取整合的服務帳戶。如要變更或更新整合的服務帳戶詳細資料，請隨時前往整合工具列的「整合摘要」窗格。
    4. 點選「建立」。

    新建立的整合服務會在整合服務編輯器中開啟。

  4. 在整合編輯器的導覽列中，按一下「觸發條件」，即可查看可用觸發條件的清單。
  5. 在整合服務編輯器中，按一下並放置「Webhook trigger」(Webhook 觸發條件) 元素。

    6. 如要設定 Webhook 觸發條件，您可以使用整合連接器中現有的 Webhook 連線，也可以使用內嵌連線建立選項建立新的 Webhook 連線。

使用現有連線設定 Webhook 觸發條件

您可以使用 Integration Connectors 中的現有 Webhook 連線，設定 Webhook 觸發條件。請注意，Webhook 觸發條件是連結器事件觸發條件，因此您只能使用已啟用事件訂閱的 Webhook 連線來設定觸發條件。

如要瞭解如何使用新的 Webhook 連線設定 Webhook 觸發條件，請參閱「使用新連線設定 Webhook 觸發條件」一文。

如要使用現有的 Webhook 連線設定 Webhook 觸發條件，請按照下列步驟操作：

  1. 按一下整合服務編輯器中的「Webhook trigger」(Webhook 觸發條件) 元素，開啟觸發條件設定窗格。
  2. 按一下「設定觸發條件」。
  3. 在「連接器事件觸發條件編輯器」頁面中，提供下列設定詳細資料：
    1. 「Region」(地區)：選取 Webhook 連線的地區。
    2. 連線：選取要使用的 Webhook 連線。

      應用程式整合只會顯示處於有效狀態，且已啟用事件訂閱的 Webhook 連線。

    3. 事件訂閱類型：輸入要用來觸發整合的事件類型。
    4. 服務帳戶：選取具有 Webhook 觸發程序必要 IAM 角色的服務帳戶。
  4. 按一下「完成」即可完成觸發條件設定並關閉頁面。
詳情請參閱 Webhook 連線說明文件。

使用新連線設定 Webhook 觸發條件

如要使用新的 Webhook 連線設定 Webhook 觸發條件，請執行下列步驟：

  1. 按一下整合服務編輯器中的「Webhook trigger」(Webhook 觸發條件) 元素，開啟觸發條件設定窗格。
  2. 按一下「設定觸發條件」。
  3. 略過「區域」欄位。
  4. 按一下「連線」，然後從選單中選取「建立連線」選項。
  5. 在「Create Connection」(建立連線) 窗格中完成下列步驟：
    1. 在「位置」部分中，選擇連線位置。
      1. 區域：從清單中選取位置。

        連接器支援的地區包括：

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

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

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

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

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

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

觸發輸出

Webhook 觸發條件需要幾分鐘才能完成事件訂閱設定。您可以在「事件訂閱詳細資料」下方的觸發條件設定窗格中，查看事件訂閱狀態。

Webhook 觸發條件會使用下列狀態，指出事件訂閱的狀態：

  • Creating：表示觸發條件正在訂閱事件訂閱項目。
  • Active：表示觸發條件已成功訂閱事件訂閱項目。
  • Error：表示設定的事件訂閱項目有問題。

除了事件訂閱狀態，「事件訂閱詳細資料」部分也會顯示其他詳細資料，例如連線區域、連線名稱、事件訂閱名稱等。

觸發條件輸出變數

對於每個事件，Webhook 觸發程序都會產生 ConnectorEventPayload 輸出變數，您可以在下游工作中使用。輸出變數為 JSON 格式，內含輸出 Webhook 酬載結構定義。

查看事件訂閱項目

如要查看及管理與 Integration Connectors 中連線相關聯的所有事件訂閱項目，請按照下列步驟操作：

  1. 前往「整合連接器」>「連線」頁面。

    前往「連線」頁面

  2. 按一下要查看訂閱項目的連結。
  3. 按一下「事件訂閱」分頁標籤。

    系統會顯示連線的所有事件訂閱項目。

編輯 Webhook 觸發條件

您可以編輯 Webhook 觸發程序，變更或更新連線設定和事件訂閱詳細資料。

如要編輯 Webhook 觸發條件，請按照下列步驟操作：

  1. 按一下整合服務編輯器中的「Webhook trigger」(Webhook 觸發條件) 元素，開啟觸發條件設定窗格。
  2. 按一下「設定 Webhook 觸發條件」。
  3. 在「Connector Event Trigger Editor」(連接器事件觸發條件編輯器) 頁面中執行下列操作：
    1. 如要保留先前設定的事件訂閱項目，請按一下「保留」，否則請按一下「刪除」。
    2. 視需要更新連線設定和事件訂閱詳細資料。
    3. 按一下 [完成]。

    4. 您可以在「事件訂閱詳細資料」下方的觸發條件設定窗格中，查看更新後的連線和事件訂閱詳細資料。

配額與限制

如要瞭解配額和限制，請參閱配額和限制。

後續步驟