Webhook
Webhook 是动作"对外部系统说话"的通道:当有人在 Foundry 里执行动作,就向外部系统(如 Salesforce、SAP 或任意 HTTP 服务)发一个请求,把决策写回去。这一篇讲清两种配置模式与参数机制。
https://www.palantir.com/docs/foundry/action-types/webhooks/
原始标题:Webhooks
一句话速览
Webhook:Webhook 是动作"对外部系统说话"的通道:当有人在 Foundry 里执行动作,就向外部系统(如 Salesforce、SAP 或任意 HTTP 服务)发一个请求,把决策写回…
Webhook 是什么
一个把请求"发到 Foundry 之外"的概念,让本体工作流直接连上源系统。
Webhook 本是属于 Data Connection 的一个概念:向外部系统(如 Salesforce、SAP 或任意配置好的 HTTP 服务器)发送请求,通常是为了修改那个外部系统的数据。
在动作里用 Webhook,有两种配置方式:作为 writeback(写回),或作为 side effect(副作用)。它们的关键区别在于执行时机与失败是否暴露给用户。下节细说。
写回(writeback)vs 副作用(side effect)
核心差异:在对象改动之前还是之后执行,失败是否给用户看。
| 类型 | 执行时机 | 失败会显示给用户吗? |
|---|---|---|
| Writeback | 对象改动之前 | 会(用户看到错误) |
| Side effect | 对象改动之后 | 不会(可能成功提示后才跑) |
把每行描述归到正确的模式(点击右侧):
输入参数(input parameters)
必填输入要么映射到动作参数,要么用一个函数算出来。
在动作里配 Webhook,必须填完它所有必填输入参数。两种方式:
- 映射到动作参数:每个必填输入可设为"同类型的动作参数""静态值"或"对象参数的属性"。
- 用函数(Function):选一个返回自定义类型、且强匹配 Webhook 输入结构的函数;否则会报
OntologyMetadata:ActionWebhookInputsDoNotHaveExpectedType错误。
函数方式特别适合"用逻辑填输入",尤其是基于本体对象取值——比如取关联对象、拉它的属性来预填 Webhook 输入。函数还能返回一个payload 列表,让一个 side effect Webhook 被触发多次。
输出参数(output parameters)
只有 writeback 才有;把外部返回的数据接回本体。
当一个 Webhook 配成 writeback 时,它的输出参数可以在后续规则里使用——比如外部系统返回的数据,你想立刻写进某个 Foundry 对象,或用在随后的通知 / 另一个 side effect Webhook 中。
Side effect 模式没有"输出参数可被后续规则使用"这一说,因为它在对象改动之后才跑。
OAuth 2.0 鉴权
用出站应用(outbound application)时,Foundry 帮你管 token。
当 Webhook 配置在一个使用出站应用(outbound application)做鉴权的 REST API 源上时,Foundry 会代你完成 OAuth 2.0 授权流程:开发者无需自己获取或刷新 token,Foundry 在每次 Webhook 调用时自动带上正确的访问令牌(access token)。
一页带走
延伸阅读 · 相关页面
按主题横向跳转,不必顺着目录一篇篇读。
常见问题速答 · FAQ
关于「Webhook」,读者最常问的几个问题。