跳到主要内容 跳到补充内容

为工作流创建 Webhook

webhook 提供了一种在工作流中使用 Qlik Cloud 系统事件作为触发器的方法。一旦创建了 webhook,只要定义的系统事件发生,它就会自动向 webhook 端点发送 JSON 请求。您可以使用 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 端点。数据作为 JSON 请求传递到端点 URL。

信息注释要了解有关事件有效负载的更多信息,请参阅 Qlik Developer 门户: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 历史记录

您可以访问 管理控制台Webhooks 下的 Webhook 历史记录。

信息注释事件交付将在 7 天后从 Webhook 历史记录中删除。
  • 要查看 Webhook 历史记录,请单击 Webhook 行末尾的 向下箭头 UI 图标用于展开 Webhook 菜单 按钮。

    即会显示 Webhook 历史记录。

    管理控制台 Webhook 历史

  • 要手动重新发送事件交付,请单击事件行末尾的 用于重新发送 Webhook 的“重新发送”图标 按钮。

  • 要查看事件响应负载,请单击事件行末尾的 向下箭头 UI 图标用于展开事件有效负载菜单 按钮。

    管理控制台 Webhook 事件类型有效负载信息

了解详情

本页面有帮助吗?

如果您发现此页面或其内容有任何问题 – 打字错误、遗漏步骤或技术错误 – 请告诉我们如何改进!