排课系统帮助中心

Webhook是锦中排课系统与外部系统进行实时通信的重要接口。通过Webhook，系统可以主动将特定事件通知给第三方应用，从而实现自动化流程和数据同步。

Webhook请求采用HTTP POST方法发送，所有请求必须使用HTTPS协议以确保传输安全。请求头中应包含Content-Type: application/json，以标明数据格式为JSON。

Webhook的请求体包含以下字段：

- event：表示触发Webhook的事件类型，例如“class_schedule_updated”或“teacher_availability_changed”。

- timestamp：事件发生的Unix时间戳，用于记录事件发生的时间。

- payload：包含具体事件数据的对象，结构根据不同的事件类型而变化。

事件类型定义如下：

- class_schedule_updated：课程安排更新。

- teacher_availability_changed：教师可用性发生变化。

- room_booking_confirmed：教室预订确认。

- course_deleted：课程被删除。

- user_role_changed：用户角色变更。

每个事件类型的payload结构需符合预定义的数据模型，确保接收方能够正确解析。例如，当event为“class_schedule_updated”时，payload可能包含新的课程信息、原课程信息以及修改人信息等。

Webhook的调用需配置在系统的管理后台，用户可设置Webhook的URL、事件类型和启用状态。系统会根据配置的条件，自动触发相应的Webhook请求。

为了防止重复调用和保证消息的可靠性，系统支持重试机制。若Webhook请求失败，系统将在一定时间后重新尝试发送，最多重试三次。若仍无法成功，系统将记录错误日志并通知管理员。

安全方面，Webhook请求需通过签名验证。系统生成一个密钥（Secret Key），用于对请求内容进行HMAC-SHA256签名。接收方需验证签名是否合法，以确保请求来源可信。

Webhook的响应应为200状态码，否则视为处理失败。如果接收方返回非200状态码，系统将记录该失败事件，并按照重试策略进行处理。

对于开发者而言，建议在接收Webhook请求时，先进行签名验证，再处理业务逻辑。同时，应对请求内容进行校验，避免因异常数据导致系统异常。

Webhook的设计遵循RESTful风格，保持简洁、一致和可扩展性。未来如有新增事件类型或数据结构变化，将通过版本控制进行管理，确保兼容性。

在部署Webhook服务时，建议采用异步处理机制，提高系统性能和稳定性。同时，应设置合理的超时时间和重试策略，以适应网络波动和系统负载变化。

文档中提到的所有接口和数据结构均基于当前版本，后续如有更新，将通过官方公告或API版本号进行说明。

本规范旨在为开发者提供清晰的Webhook使用指南，确保与锦中排课系统的集成顺利进行。如在使用过程中遇到问题，可参考官方文档或联系技术支持团队获取帮助。