选择语言

Webhooks

Webhooks 允许 Shifton 在公司发生事件时向外部系统发送实时通知。


分步说明

访问 Webhooks 选项卡

1
在左侧边栏中点击 集成
2
进入 开发者 页面 → Webhook 选项卡。

创建新 webhook

1
点击 “新的 Webhook”
2
填写配置:
字段描述
URL接收事件数据的端点
事件触发 webhook 的 Shifton 事件
活动启用/禁用开关
1
保存。Shifton 将向指定 URL 发送 HTTP POST 请求。

管理 webhooks

Shifton screenshot

点击 webhook 编辑 URL、更新事件或更改活动状态。

测试 webhook

Shifton screenshot
Shifton screenshot
1
在 Shifton 中触发相应事件(例如,创建测试班次)。
2
检查服务器日志——数据应该已收到。

相关文章

常见问题

Shifton screenshot

问:轮班on 以什么格式发送数据?
HTTP POST,请求体为 JSON 格式。各事件类型的数据结构请参阅 API 文档。

问:能否为同一事件创建多个 Webhook?
可以,使用不同的 URL。

问:webhook 触发时服务器不可用会怎样?
投递可能失败。重试策略的详情请参阅 API 文档。

问:webhook 没有触发——为什么?
确保 活动 开关已启用且 URL 可公开访问。

问:如何验证 webhook 正在接收数据?
在 Shifton 中创建测试事件(例如,添加班次),然后检查服务器日志中的 POST 请求。

问:能否配置 webhook 身份验证?
可以。在 webhook 的 URL 或头部中添加密钥或令牌。详情请参阅 API 文档。

问:webhook 请求体是什么样的?
包含事件数据的 JSON 对象。结构取决于事件类型——请参阅 API 文档中的示例。

问:一个 webhook 能否跟踪多个事件?
可以。创建 webhook 时选择多个事件——一个 URL 将接收所有选定事件的通知。

问:什么是 webhook 的”重试策略”?
如果服务器返回错误(非 200),Shifton 可能会重试请求。具体取决于平台配置。

问:Webhook 数量有限制吗?
文档中未指定限制,但建议仅创建必要的 webhooks。

问:webhook URL 是否需要使用 HTTPS?
推荐使用。HTTP 地址可能可以工作,但 HTTPS 确保数据安全传输。

问:能否在每次排班变更时接收 webhook 通知?
可以。配置 webhook 时添加”Shift 已创建”或”schedule updated”类型的事件。

问:谁有权创建 Webhook?
仅 Owner 和。Manager 和员工无法看到 Developer 部分。

问:能否禁用 webhook 而不删除它?
可以。关闭 webhook 设置中的 活动 开关——它将停止触发但保留配置。

问:webhook 触发是否在 轮班on 中记录?
界面中不提供 webhook 的详细投递日志。跟踪在您的服务器端进行。

问:能否按项目或排班筛选 webhook?
不能。webhook 对选定类型的所有公司级事件触发。筛选在接收服务器端进行。

问:删除公司后 webhook 会怎样?
所有 webhooks 随公司一起删除。