跳转到内容
PynPyn

Webhooks

入站 webhook 是另一个系统向其发送 JSON 的地址。每个 webhook 属于一个表单:到达的负载成为该表单的一次提交,归属于负载所指定的员工,而这次提交可以触发自动化流程。Webhook 在表单上创建,在它的 Webhook 侧面板中;Settings 把它们全部列在一个地方。

The Webhooks view in Settings, listing the workspace's inbound webhooks.
Settings > General > Webhooks lists every inbound webhook created on a form.
  • 端点是 POST /api/webhook/<webhook id>,带有请求头 Authorization: Bearer <secret> 和一个 JSON 正文。面板显示要发送的 URL 和 Header:“Post a JSON body here, with the secret as a bearer token.”
  • 正文用 subject_id 指定员工,答案放在 fields 下。表单的 Subject 设置说明这个 id 来自哪个源系统,例如 BambooHR 员工 id。
  • 每次调用一经接受就以 202 应答;History 标签页记录每个负载的最终结果。条目带有一个代码,例如 submitted、unknown-subject、missing-fields、invalid-fields、ambiguous-fields 或 already-submitted。
  • 发送一个 Idempotency-Key 请求头让重试变得安全:同一个键的重复请求会再次以 202 应答,但不会被第二次处理。
  • Pyn 无法接收的负载会在通知中发出一条通知;调用方重复同一个错误只会更新一条通知,而不是发出许多条。管理员也可以收到电子邮件;见设置通知电子邮件。
  • Webhook 在拥有密钥之前不接受任何内容,已归档的 webhook 停止接受负载。
  • 创建或替换 webhook 密钥
  • 从 webhook 的面板重命名它:编辑 Title,然后按 Enter 或点击其他位置保存
  • 查看负载的 History,并从表单的 Webhook 侧面板把整个日志导出为 CSV
  • 从 webhook 的 … 菜单归档它

在 Pyn 中打开 /settings/general/webhooks,或打开主导航中的 Settings,然后选择 General 下的 Webhooks。要创建 webhook,在表单中打开该表单,选择侧栏中的 Settings,然后选择 Add Webhook。