配置Webhook听众

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

添加webhook监听器需要你熟悉你的目标应用System of Record,并设置必要的工具和管理权限来配置这些位置的webhook。

通过以下方法设置集成后配置webhooks数据加载并遵循以下步骤:

  1. 点击Webhook听众在HTTP Integration界面的左手栏中:

    Webhook听众

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

授权方法

您可以选择令牌授权方法或没有一个在配置授权方法时。配置令牌方法遵循以下步骤:

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

    • 自定义标题
    • 查询参数
    • 授权头
  4. 定义的的名字或者是前缀这取决于你选择的阅读方法。

令牌现在设置好了。

请求方法

当配置Webhook监听器时,使用以下定义来构建调用:

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

定义数据结构

您可以使用类似的方法定义数据结构获取数据结构数据加载配置。有关更多信息,请参见配置集成

按照以下步骤定义webhook数据结构:

  1. 设置您希望的数据保存时间。所有比这个日期更早的条目将被删除。每个保存的条目都包含其修改日期和时间。这是lastModified.这个日期和时间用于决定要删除哪些条目。
  2. 选择生成表

    生成表屏幕上打开。

    将目标应用程序System of Record的JSON示例请求粘贴到这里。

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

完成此过程后,在目标应用程序System of Record管理中完成配置措施后,选择添加

你的webhook现在已经配置好了。

脚本支持

控件中配置的Webhook监听器支持自定义脚本HTTP集成脚本特性。

关于开发和实现自己的脚本,您可以在Citrix开发者门户

显示Webhook日志

使用Webhook日志查看所有webhook端点的请求和错误的历史记录。您可以通过webhook名称和状态进行过滤,例如成功、错误或全部。出于性能考虑,webhook日志界面只保留最后10条webhook日志条目供查看。

  1. 在Manage Microapps页面中,选择要查看集成日志的集成旁边的菜单。
  2. 选择Webhook日志
  3. 检查条目,并根据需要从菜单中选择进行筛选。
配置Webhook听众