查看 Application Integration 支援的連接器。

Webhook 觸發條件

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

事前準備

如果您打算為 Webhook 觸發事件建立或設定新的連線，請務必在專案中具備下列 Identity and Access Management (IAM) 角色：

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

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

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

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

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

新增 Webhook 觸發條件

如要將 Webhook 觸發條件新增至整合，請執行下列步驟：

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

    前往「應用程式整合」

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

    系統隨即會顯示「Integrations List」頁面，列出 Google Cloud 專案中可用的所有整合項目。

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

    如果您要建立新的整合功能：

    1. 在「Create Integration」窗格中輸入名稱和說明。
    2. 選取整合作業的區域。
    3. 選取要用於整合的服務帳戶。您隨時可以透過整合工具列的 「整合摘要」窗格，變更或更新整合作業的服務帳戶詳細資料。
    4. 按一下 [建立]。

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

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

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

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

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

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

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

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

      「應用程式整合」只會顯示已啟用事件訂閱的有效 Webhook 連結。

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

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

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

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

        支援的連接器地區包括：

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

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

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

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

觸發輸出

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

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

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

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

觸發輸出變數

對於每個事件，Webhook 觸發事件都會產生 ConnectorEventPayload 輸出變數，可用於後續工作。輸出變數採用 JSON 格式，其中包含輸出 Webhook 酬載結構定義。

查看事件訂閱項目

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

  1. 前往「Integration Connectors」>「Connections」頁面。

    前往「連線」頁面

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

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

編輯 Webhook 觸發條件

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

如要編輯 Webhook 觸發條件，請執行下列步驟：

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

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

配額與限制

如要進一步瞭解配額和限制，請參閱「配額與限制」。

後續步驟