建立與管理工作流程的 Webhook | Qlik Cloud 說明
跳到主要內容 跳至補充內容

建立與管理工作流程的 Webhook

上次更新:2026/9/8

Webhook 是一種簡單的方法,可透過在發生特定動作時自動傳送事件資料,將應用程式之間的通訊自動化。在 Qlik Cloud 中,Webhook 可以在無需手動介入的情況下觸發其他應用程式中的動作,讓您更輕鬆地將 Qlik Cloud 整合到您的工作流程中,並根據系統事件將工作自動化。每次發生定義的事件時,都會將 JSON 請求傳送到指定的 Webhook 端點,將事件資料傳遞到您選擇的應用程式。

必要的 Webhook 權限

使用 Qlik Cloud Webhooks 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。

  • 每個 Webhook 的 HTTP 標頭總大小限制為:加密標頭 2048 個位元組,非加密標頭 2048 個位元組。對於每種標頭類型,限制是所有設定的標頭名稱和值加總的總位元組大小。標頭數量沒有限制。

資訊備註從 2025 年 11 月 3 日起,舊版事件格式已替換為新的 Qlik Cloud 事件格式。所有舊版事件都使用包含舊版和雲端事件承載的暫時混合事件。資料整合事件會作為雲端事件發出,未來不需要移轉。如需 Qlik Cloud 中支援的事件和事件類型的完整清單,請參閱 支援的 Webhook 事件類型。如需有關新 Qlik Cloud 事件的詳細資訊,請參閱 Qlik 社群:移轉至新事件格式

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 (僅提供英文版)

請執行下列動作:

  1. 管理 活動中心,移至 Webhook

  2. 按一下建立新增

  3. 輸入 Webhook 的名稱,並選擇性地新增說明。

  4. 對於 URL (端點),輸入 Webhook 將傳送 JSON 資料的完整網域名稱 (FQDN)。

    • 此 URL 必須使用 HTTPS 協定 (例如:https://domain.com)。IP 位址不能用作 Webhook 端點。

  5. 選擇性地輸入用於 Webhook 驗證的密碼

    • 密碼必須介於 32 到 64 個字元之間。

    • 如果建立,密碼將作為雜湊的一部分包含在內,並作為 qlik-signature 附加到 HTTP 請求中。

  6. 雲端事件 Qlik Cloud Webhooks 服務發出的事件承載。啟用並儲存後,即無法復原變更。

  7. 啟用檢查憑證撤銷時,會驗證 Webhook 憑證是否有效且未被撤銷。

  8. 選擇性地新增要附加到請求的 HTTP 標頭。選取核取方塊以加密標頭值

    資訊備註基於安全考量,您無法編輯加密標頭,若要刪除標頭,請按一下刪除圖示。若要移除值,請按一下移除圖示並輸入新值。
  9. 事件下,選擇將觸發 Webhook 的系統事件。可用的事件包括:

    • 自動化事件

    • API 事件

    • 應用程式事件

    • 資料整合事件

    • 使用者事件

  10. 按一下建立

資訊備註如果您在有未儲存的變更時按一下取消,則會出現確認對話方塊。按一下捨棄以關閉而不儲存您的變更。

管理 Webhook

資訊備註

使用 Qlik Automate 建立的 Webhook 只能在 管理 活動中心檢視。無法對其進行編輯、刪除、啟用或停用。

若要管理這些 Webhook,請使用 Qlik Automate 介面。

排序和搜尋 Webhook

若要在表格中排序和搜尋 Webhook:

  • 按一下欄頂部的 上下箭頭 以變更排序順序。

  • 按一下欄頂部的 篩選條件 以搜尋 Webhook。搜尋篩選條件適用於完全和部分相符。

Webhook 表格。

管理主控台 Webhook 表格

開啟或關閉 Webhook

請執行下列動作:

  1. 管理 活動中心,移至 Webhook

  2. 按一下 Webhook 旁邊的 更多

  3. 若要開啟 Webhook,請選取 啟用

  4. 若要關閉 Webhook,請選取 停用

新建立的 Webhook 預設為啟用。

編輯 Webhook

請執行下列動作:

  1. 管理 活動中心,移至 Webhook

  2. 對於您要編輯的 Webhook,按一下 更多

  3. 選取編輯

  4. 進行編輯並按一下儲存

資訊備註如果您在有未儲存的變更時按一下取消,則會出現確認對話方塊。按一下捨棄以關閉而不儲存您的變更。

刪除 Webhook

請執行下列動作:

  1. 管理 活動中心,移至 Webhook

  2. 選取要刪除的 Webhook。

  3. 按一下刪除

  4. 確認刪除。

資訊備註在您選取一或多個 Webhook 之前,刪除按鈕無法使用。動作列會顯示所選 Webhook 的數量。

檢視 Webhook 歷程記錄

Webhook 事件歷程記錄會保留 7 天。

請執行下列動作:

  1. 管理 活動中心,移至 Webhook

  2. 按一下 Webhook 旁邊的 向下箭頭 UI 圖示以展開 Webhook 選單 以展開其事件歷程記錄。

    Webhook 歷程記錄。

    管理主控台 Webhook 歷程記錄
  3. 若要手動重新傳送事件傳遞,請按一下事件列上的 重新傳送圖示

  4. 若要檢視事件回應承載,請按一下事件列上的 向下箭頭

    承載會顯示應用程式 ID、名稱和時間戳記等詳細資訊,這對於偵錯或稽核過去的事件很有用。

    事件回應承載。

    管理主控台 Webhook 事件類型承載資訊

此頁面是否對您有幫助?

若您發現此頁面或其內容有任何問題——錯字、遺漏步驟或技術錯誤——請告知我們!