配置 Webhook 侦听器

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

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

通过数据加载设置集成后,配置您的 Webhook,并按照以下步骤操作:

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

    配置 Webhook 侦听器

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

授权方法

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

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

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

令牌现在已设置。

定义数据结构

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

要定义您的 webhook 数据结构,请执行以下步骤:

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

    此时将打开生成表屏幕。

    从目标应用程序记录系统粘贴您的 JSON 示例请求。

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

在目标应用程序“记录系统”管理中完成此过程并完成配置度量后,请选择添加

您的 Webhook 现已配置。

显示 Webhook 日志

使用 Webhook 日志查看来自所有 Webhook 终端节点的请求和错误的历史记录。您可以按 Webhook 名称和状态进行筛选,如成功、错误或全部。

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