跳到主要內容 跳至補充內容

為工作流程建立 Webhook

Webhook 向您提供在工作流程中使用 Qlik Cloud 系統事件作為觸發的方式。建立 Webhook 後,只要發生定義的系統事件,就會自動將 JSON 請求傳送至 Webhook 端點。您可以使用 Webhook 將事件資料傳送至任何可以接收 JSON 資料的應用程式。

Webhook 屬性

若要建立 Webhook,必須設定 Webhook 和端點屬性,並選擇 Qlik Cloud 事件類型。

Webhook 屬性
屬性 描述
名稱 Webhook 名稱。
Description (選填) Webhook 描述。
URL Webhook 端點的 URL。URL (Webhook 端點) 必須是完全合格的網域名稱 (FDQN) 並且必須使用 HTTPS 通訊協定。端點不可以是 IP 位址。
Secret (選填) 用於 Webhook 驗證的密碼。密碼必須介於 32 個字元和 64 個字元之間。若您建立 webhook 密碼,這屬於作為 qlik-signature 附加到 HTTP 請求的雜湊。
Headers (選填)

可附加到 HTTP 請求的標頭。

每個 Webhook 都以一個或多個事件類型來設定。

Webhook 的事件類型
資源 事件類型
應用程式 已建立、已刪除、資料已更新、已載入、已發佈、已匯出
資訊備註資料更新事件意指正在重新整理的資料。載入事件意指正在載入的 Qlik Sense 應用程式和相關資料表格。
使用者 已建立、已刪除

Webhook 會等待其中一個事件發生,發生後,就會將事件資料傳送至 Webhook 端點。資料會傳遞至端點 URL 作為 JSON 請求。

資訊備註若要進一步瞭解事件裝載,請參閱 Qlik 開發人員入口網站:API 事件

範例: 應用程式已刪除事件類型的 JSON 請求

Request
URL
https://api.blendr.io/v1/widgets/F502987A-AF89-4992-8127-F28794C5A74A?X-Execution-Token=xxxxx
Headers
{
    "Content-Type": "application/json",
    "Qlik-Signature": "446bd5e3f5b635f491d17557e4bec6ebc61b7bd2bc9cc7b612e4e",
    "User-Agent": "Qlik Webhook"
}
Body
{
    "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
        }
    }
}

建立 webhook

您可從 管理主控台 建立 Webhook。您也可以從 Qlik 應用程式自動化介面建立 Webhook。如需更多資訊,請參閱使用 Webhook (僅提供英文版)

您最多可為每個租用戶建立 100 個 Webhook。

  1. 管理主控台 中,前往 Webhook

  2. 在右上角按一下建立新內容

  3. 建立 Webhook 對話方塊中,輸入 Webhook 名稱。

  4. 新增選填描述。

  5. 輸入第三方整合應用程式的 URL。

  6. 可以選擇輸入密碼以附加至 HTTP 請求。

  7. 可以選擇新增 HTTP 標頭以附加至請求。

  8. 事件之下,選取 Webhook 的事件類型。

  9. 完成後,按一下建立

    Webhook 列於表格中。新建立的 Webhook 依預設為開啟。

管理主控台 Webhook 表格
提示備註您可以按一下 Webhook 列末端的 三點 UI 圖示可開啟 Webhook 的選項功能表 按鈕並選取啟用 Webhook停用 Webhook 以開啟或關閉 Webhook。Webhook 依預設為開啟。
提示備註您可以按一下任一欄頂端的 上下箭頭圖示可排序欄值 圖示以變更排序順序,或按一下每欄頂端的篩選圖示 每個 Webhook 欄頂端的篩選圖示 以手動搜尋 Webhook,藉此在表格中排序並搜尋 Webhook。搜尋篩選適用於完全和部分相符。

編輯 webhook

  1. 管理主控台 中,前往 Webhook

  2. 對於您要編輯的 Webhook,按一下該列末端的 三點 UI 圖示可開啟 Webhook 的選項功能表 按鈕。

  3. 按一下編輯

    會顯示編輯面板,並含有變更 Webhook 設定的選項。

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

刪除 webhook

  1. 管理主控台 中,前往 Webhook

  2. 選取要刪除的 Webhook。

  3. 在右上角按一下刪除

  4. 會開啟快顯對話方塊,以確認您的選擇。按一下刪除

檢視 Webhook 歷史記錄

您可在 管理主控台 中的 Webhook 之下存取 Webhook 歷史記錄。

資訊備註7 天後,會從 Webhook 歷史記錄中移除事件傳遞內容。
  • 若要檢視 Webhook 歷史記錄,按一下 Webhook 列末端的 向下箭頭 UI 圖示可展開 Webhook 功能表 按鈕。

    就會顯示 Webhook 歷史記錄。

    管理主控台 Webhook 歷史記錄

  • 若要手動重新傳送事件傳遞內容,按一下事件列末端的 用來重新傳送 Webhook 的重新傳送圖示 按鈕。

  • 若要檢視事件回應裝載,按一下事件列末端的 向下箭頭 UI 圖示可展開 Webhook 事件裝載功能表 按鈕。

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

瞭解更多資訊

此頁面是否對您有幫助?

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