动作类型详解

配置 Webhook(Set up a webhook)

跟着做一遍:给一个动作加上 Webhook,把数据发往外部系统。本篇是手把手教程,从前置条件到保存,重点讲清"副作用 / 写回"模式的取舍。

原文 Palantir Foundry · Action types
本文来源 · Source 内容整理自 Palantir Foundry 官方文档:
https://www.palantir.com/docs/foundry/action-types/set-up-webhook/
原始标题:Set up a webhook

一句话速览

配置 Webhook(Set up a webhook):跟着做一遍:给一个动作加上 Webhook,把数据发往外部系统。本篇是手把手教程,从前置条件到保存,重点讲清"副作用 / 写回"模式的取舍。

1 前置条件
开始前需要两件事
2 添加一条 Webhook 规则
示例里我们假设已有一个叫 Modify ticket priority 的 Webhook,它接收一个 priority 字符串并发…
3 副作用 or 写回
新加的 Webhook 默认被配成 side effect——也就是在 Foundry 里的对象被改之后才运行
4 选择 Webhook 并配置输入
在下方菜单里选你要执行的 Webhook(示例选 Modify ticket priority),需要的话还可以选它的某个版本(ve…
1

前置条件

先有一个基础动作,且在 Data Connection 里先建好 Webhook。

开始前需要两件事:

  • 已完成动作的入门教程(Getting Started),知道怎么建一个基础动作;
  • 已在 Data Connection建好一个 Webhook(用于连接外部系统)。这一步可能需要有"连接源系统"权限的管理员协助。
点击揭晓:为什么"建 Webhook"这一步常需要管理员?
2

添加一条 Webhook 规则

在动作的 Logic 标签页里,Add new rule → Webhook。

示例里我们假设已有一个叫 Modify ticket priority 的 Webhook,它接收一个 priority 字符串并发往外部系统。

打开你的动作,切到 Logic 标签页,点 Add new rule,然后选 Webhook。这会新增一条 Webhook 规则。

3

选择模式:副作用 or 写回

默认是 side effect(改完再发);想"外部不成、本体不改"就选 Writeback。

新加的 Webhook 默认被配成 side effect——也就是在 Foundry 里的对象被改之后才运行。如果你要它先在外部系统执行、再改本体,就选 Writeback

默认 SIDE EFFECT

对象改完 → 再发请求。用户先看到成功,失败不阻塞本体改动。

or
可选 WRITEBACK

先发请求 → 再改对象。外部失败则动作停下、本体不改。

4

选择 Webhook 并配置输入

选中具体的 Webhook(可指定版本),再把输入映射到动作参数。

在下方菜单里选你要执行的 Webhook(示例选 Modify ticket priority),需要的话还可以选它的某个版本(version)

接着配置输入参数:

  • 默认会为每个 Webhook 输入生成一个新动作参数;
  • 若已存在同名的动作参数,则自动复用、直接配好;
  • 本例把 Webhook 输入 priority 映射到已有的动作参数 Ticket Priority

配好后点 Add webhook 把这条规则加进动作。Rules 区会显示:写回会在对象被修改之前发生。

5

收尾并保存

清理无用参数,点保存,动作就能触发外部请求了。

  • 删除多余的自动生成参数如果加 Webhook 时生成了现在用不到的参数,顺手清掉。
  • 点右上角 Save保存对动作的修改。
  • 生效之后动作被应用时,向外部系统的请求会在本体改动之前发出(Writeback 模式)。
下一步:想了解 Webhook 的全部选项,回看 Webhooks 总览;要用函数配置输入,可查 Input parameters 一节。

一页带走

① 先有连接
Data Connection 里先建 Webhook(常需管理员),动作里才能引用。
② Logic 里加
Logic → Add new rule → Webhook,新增一条规则。
③ 默认副作用
默认 side effect(改后发);要"外部先成"就改 Writeback。
④ 映射输入
输入映射到动作参数,清理无用参数后 Save 生效。

延伸阅读 · 相关页面

按主题横向跳转,不必顺着目录一篇篇读。

常见问题速答 · FAQ

关于「配置 Webhook(Set up a webhook)」,读者最常问的几个问题。

添加一条 Webhook 规则是什么?
示例里我们假设已有一个叫 Modify ticket priority 的 Webhook,它接收一个 priority 字符串并发往外部系统。
选择模式:副作用 or 写回是什么?
新加的 Webhook 默认被配成 side effect——也就是在 Foundry 里的对象被改之后才运行。如果你要它先在外部系统执行、再改本体,就选 Writeback。
选择 Webhook 并配置输入是什么?
在下方菜单里选你要执行的 Webhook(示例选 Modify ticket priority),需要的话还可以选它的某个版本(version)。