微应用

配置 Webhook 侦听器

配置 webhook 侦听器(也称为 HTTP 推送 API),使微应用能够向最终用户提供接近实时的数据。配置 webhook 可以让你的应用以比从微应用平台端同步更快的速度向其他应用程序传递数据。MA 服务器可以处理的 webhook 请求正文的最大大小为 64 kb。

添加 webhook 侦听器需要您熟悉目标应用程序记录系统,并设置必要的工具和管理权限,以便在这些位置配置 Webhook。

在通过 数据加载 设置集成之后配置你的 webhook,然后按照以下步骤操作:

  1. 单击 HTTP 集成屏幕左侧栏上的 Webhook 侦听器

    Webhook 听众

  2. 输入你想要的 webhook 名称。
  3. 选择 复制 以复制 webhook URL,以便在目标记录系统管理界面中使用。

授权方法

配置授权方法时,您可以选择 令牌 授权方法或 。要配置 令牌 方法,请执行以下步骤:

  1. 授权 方法菜单中选择 令牌
  2. 选择 生成令牌 ,然后选择 复制 以将令牌添加到剪贴板,以便在目标记录系统管理界面中使用。
  3. 从中选择 读取令牌 以进行选择:

    • 自定义标题
    • 查询参数
    • 授权标头
  4. 根据您选择的读取方法定义 名称前缀

令牌现已设置。

请求方法

配置 Webhook 侦听器时,请使用以下定义构建调用:

  • PUT 用于更新现有资源。
  • POST 会创建新的从属资源,因此 POST 方法用于在资源集合中创建新的资源。 PUT 和 POST 都使用根表的主键信息从子表中删除数据。然后它会替换现有记录或插入一条新记录。
  • DELETE 用于删除资源。 DELETE 有两个端点:
    • {serviceUuid}/{webhookListenerUuid}/{recordId} 其中 recordId 是要删除的根表中记录的主键的值。相应地删除子表中的记录。
    • {serviceUuid}/{webhookListenerUuid}/?id1=1&id2=1 其中 id1id2 表示要删除的根表中记录的复合主键的值。相应地删除子表中的记录。
  • PATCH 请求用于对资源进行部分更新。

定义数据结构

您可以使用在数据 加载配置期间获取数据结构时描述的类似方法来定义数据 结构。有关更多信息 ,请参阅配置集成

要定义你的 webhook 数据结构,请按照下列步骤操作:

  1. 设置所需的数据保留期限。所有早于此日期的条目都将被删除。每个保存的条目都包含其修改日期和时间。那就是 lastModified。此日期和时间用于决定要删除哪些条目。
  2. 选择 “ 生成表”。

    此时将打开 “ 生成表 ” 屏幕。

    将来自目标应用程序记录系统的 JSON 示例请求粘贴到此处。

  3. 设置已创建表的基本名称。
  4. (可选)如有必要,设置 根路径
  5. 选择 “ 生成”。

在完成此过程以及目标应用程序记录系统管理中完成的配置措施之后,选择 添加

你的 webhook 现在已配置完毕。

脚本支持

Webhook 侦听器支持在 HTTP 集成 脚本功能中配置的自定义脚本。

您可以在 Citrix Developer 门户网站上找到有关开发和实施自己的脚本的更多信息。

显示 Webhook 日志

使用 Webhook 日志 查看来自所有 webhook 端点的请求和错误的历史记录。您可以按 webhook 名称和状态进行过滤,例如成功、错误或全部。为了提高性能,在 webhook 日志屏幕中仅保留最后 10 个 webhook 日志条目以供查看。

  1. 在 “管理微应用” 页面中,选择要查看其集成日志的集成旁边的菜单。
  2. 选择 Webhook 日志
  3. 查看条目,然后从菜单中选择以根据需要进行筛选。
配置 Webhook 侦听器