為工作流程建立並管理 Webhook

Webhook 是一種簡單的方法，可在發生某些動作時自動傳送事件資料，進而實現應用程式之間的通訊自動化。在 Qlik Cloud 中，Webhook 可以觸發其他應用程式中的動作，無需手動干預，進而更輕鬆地將 Qlik Cloud 整合到您的工作流程中並根據系統事件自動化任務。每次發生定義的事件時，都會將 JSON 請求傳送至指定的 Webhook 端點，以將事件資料傳送至您選擇的應用程式。

必要 Webhook 權限

使用 Qlik Cloud Webhook API 和自動化 UI 建立或管理 Webhook 時，您必須請求以下一個或兩個權限：

使用 Webhook：需要建立、檢視、更新和刪除使用者擁有的 Webhook。
管理 Webhook：需要管理租用戶中的所有 Webhook，包括其他使用者建立的 Webhook。

瞭解 Webhook

Webhook 的運作方式

若 Qlik Cloud 中發生事件 (例如建立新的應用程式或刪除使用者)，Webhook 會使用 HTTP 回呼將 JSON 格式的資訊傳送至指定的外部應用程式。然後，該外部應用程式可以使用事件資料來觸發進一步的動作。

例如︰

建立新的應用程式時，就會透過 Slack 通知您的團隊。
新的團隊成員加入租用戶時，就會自動傳送歡迎電子郵件。
從租用戶刪除使用者時，就會更新試算表。

使用 Webhook 的優點

Webhook 允許與其他系統即時整合，無需持續手動檢查或進行重複的 API 請求。藉由聽取事件並立即傳送相關資料，Webhook 減少了不必要的工作並實現順暢的自動化。

Webhook 整合的熱門平台

若要處理和回應 Webhook 資料，您可以建立自訂服務或使用第三方平台，例如：

Webhook 限制

為了維持系統效能並管理資源，有以下限制：

Webhook 傳送歷史記錄會保留 7 天。
每個使用者最多可以擁有 150 個 Webhook。
每個租用戶最多可以建立 100 個 Webhook。

Webhook 請求結構

當事件觸發 Webhook 時，會在 Webhook 建立期間向指定端點傳送 HTTP JSON 請求。此請求的結構包含事件中繼資料和承載詳細資訊，例如事件類型、時間戳記和物件屬性。

Webhook 請求範例：應用程式刪除事件

以下是刪除應用程式時傳送的 JSON 請求範例：

請求 URL

https://<your-tenantURL>/api/v1/webhooks/{id}

標頭


{
    "Content-Type": "application/json",
    "X-Execution-Token: <your-execution-token>",
    "Qlik-Signature": "446bd5e3f5b635f491d17557e4bec6ebc61b7bd2bc9cc7b612e4e",
    "User-Agent": "Qlik Webhook"
}

本文


{
    "cloudEventsVersion": "0.1",
    "source": "com.qlik/engine",
    "contentType": "application/json",
    "eventId": "e65c1481-e8a-4be-a5ca-27dfcde077d7",
    "eventTime": "2021-03-08T14:51:29Z",
    "eventTypeVersion": "1.0.0",
    "eventType": "com.qlik.v1.app.deleted",
    "extensions": {
        "ownerId": "vNRGrDZIypJzauw59BbpvkRhqbmI",
        "tenantId": "oZcMPa_1PwH4FUdrh6839YHHdEJN",
        "userId": "vNRGrDZIypJtcGTzauw59BbpqbmI"
    },
    "data": {
        "attributes": {
            "id": "0984fec4-aa8c-4253-b1d1-4fd4f9c78",
            "name": "New App",
            "createdDate": "2021-03-08T14:51:28.888Z",
            "modifiedDate": "2021-03-08T14:51:29.316Z",
            "owner": "auth0|b62a17c577a4abe6e807b07d18c4d82286352542d633d120100b03fb11",
            "ownerId": "vNRGrDZIypJtcGTzauw59BbpvbmI",
            "published": false,
            "hasSectionAccess": false
        }
    }
}

此裝載提供有關已刪除之應用程式的詳細資訊，例如其 ID、名稱、擁有者和刪除時間戳記，以協助接收系統處理事件。如需更多關於事件裝載的詳細資訊，請參閱 Qlik 開發人員入口網站：API 事件。

加密標頭

Qlik Cloud 支援加密的 HTTP 標頭。加密標頭可讓您進一步保護敏感中繼資料。運作方式：

加密的標頭值：為 Webhook 設定的標頭值可以在設定 Webhook 時加密。這可確保載入者 Token 或 API 金鑰等認證獲得安全儲存和處理。Webhook 密碼為一次寫入。儲存後，密碼無法檢視或擷取，以降低意外洩露的風險。

標頭會在儲存中加密，而非在傳輸期間加密

建立 Webhook

Webhook 可以由以下人員建立：

來自管理活動中心的租用戶管理員。
來自 Qlik Automate 介面的所有使用者。

如需更多關於使用 Webhook 搭配 Qlik Automate 的資訊，請參閱使用 Webhook （僅提供英文版）。

請執行下列動作：

在管理活動中心內，前往 Webhook。
按一下新建。
輸入 Webhook 的名稱和描述 (選填)。
對於 URL (端點)，輸入 Webhook 將在其中傳送 JSON 資料的完全限定網域名稱 (FQDN)。
- 此 URL 必須使用 HTTPS 通訊協定 (例如 https://domain.com)。IP 位址不能作為 Webhook 端點使用。
也可以輸入用於 Webhook 驗證的密碼。
- 密碼必須介於 32 到 64 個字元之間。
- 如果建立，則該密碼將作為雜湊的一部分包含在內，並以 qlik-signature 形式附加到 HTTP 請求。
也可以選擇新增 HTTP 標頭以附加至請求。選取核取方塊以加密標頭值

資訊備註基於安全性考量，您無法編輯加密標頭，若要刪除標頭，請按一下刪除圖示。若要移除該值，請按一下移除圖示並輸入新值。
在事件之下，選擇將觸發 Webhook 的系統事件。可用事件包括：
- 應用程式事件：已建立、已刪除、已匯出、資料已更新 (已重新整理)、已發佈、已載入。
- 使用者事件：已建立、已刪除。
按一下建立。