Webhook使用指南

最近更新： 2024年11月15日

Webhook是Web应用程序自动且实时彼此通信的一种方式。

传统API需要等待用户请求信息，而实时API则会在数据发生时共享数据。 Webhook充当实时API，每当发生指定事件时帮助立即共享数据。

实体

要了解Webhook事件，我们首先需要了解所涉及实体以及这些事件的触发条件。

学习对象

以下是学习对象（课程、学习路径或认证）的支持事件。

“草稿”

从UI创建学习对象时，它将以​ 草稿 ​模式启动。 这意味着学习对象尚未发布，学习者无法使用。 只要学习对象仍然是草稿，就会触发​ LEARNING_OBJECT_DRAFT ​事件。 对草稿的任何后续更新也将触发此事件。

更新

发布学习对象后，其状态会从​ 草稿 ​更改为​ 已发布。 在此过渡期间，Webhook会生成​ LEARNING_OBJECT_MODIFICATION ​事件，因为学习对象正在从​ 草稿 ​修改为​ 已发布。 学习对象的所有后续修改和更新也将触发​ LEARNING_OBJECT_MODIFICATION ​事件。

当学习对象停用时，也会触发​ LEARNING_OBJECT_MODIFICATION ​事件。 此已停用操作将基础实例标记为已更新，因为一旦父学习对象处于已停用状态，这些实例即会停用。

删除

删除学习对象后，将生成​ LEARNING_OBJECT_DELETION ​事件。 此事件表示学习对象已被删除，学习者无法再访问。

除实时事件外，学习对象事件还具有批处理（非实时）对应对象，该对应对象作为​ LEARNING_OBJECT_MODIFICATION_BATCH ​事件的一部分触发。 在通过迁移工作流程创建或修改学习对象时，会发生此事件。 由于不支持通过迁移来草稿和删除学习对象操作，因此这些操作没有对应的草稿或删除事件。

学习对象实例

以下是学习对象实例支持的事件。

更新

创建实例后，将生成​ LEARNING_OBJECT_INSTANCE_MODIFICATION ​事件。 Adobe Learning Manager中的学习对象实例不具有​ 草稿 ​状态；因此，Adobe Learning Manager不支持​ LEARNING_OBJECT_INSTANCE_DRAFT事件。 每当创建、修改或弃用实例时，都会生成此事件。

此事件除了在创建、更新或弃用实例时生成之外，在其父学习对象标记为​ 弃用 ​时也会自动生成。 这是因为当学习对象停用时，基础实例也需要标记为​ 已停用。

删除

删除实例后，将生成​ LEARNING_OBJECT_INSTANCE_DELETION ​事件。 此事件仅适用于包含自学模块的课程实例，因为Adobe Learning Manager仅允许管理员删除模块类型为自学模块的课程实例。 Adobe Learning Manager不支持明确删除其他类型的课程模块，不支持删除学习路径实例或认证实例的课程模块。

学习对象实例还具有非实时对应项，它作为​ LEARNING_OBJECT_INSTANCE_MODIFICATION_BATCH ​事件的一部分公开。 此事件在通过迁移工作流程创建或修改学习对象实例时触发。 由于迁移不支持草稿或删除学习对象实例的操作，因此相应的草稿或删除事件不可用。

注册

学习者执行注册操作后，会触发实时注册事件。 根据学习对象类型，实时注册事件可能分为以下类别之一：

  • COURSE_ENROLLMENT
  • LEARNING_PATH_ENROLLMENT
  • CERTIFICATION_ENROLLMENT

注册事件中除这些实时事件外还有批量交易方。 每当管理员、经理或平台触发注册时，都会触发非实时注册事件。 根据学习对象类型，批量注册事件可以是以下之一：

  • COURSE_ENROLLMENT_BATCH
  • LEARNING_PATH_ENROLLMENT_BATCH
  • CERTIFICATION_ENROLLMENT_BATCH

取消注册

学习者执行取消注册操作时，会触发实时取消注册事件。 根据学习对象类型，实时取消注册事件可能分为以下类别之一：

  • COURSE_UNENROLLMENT
  • LEARNING_PATH_UNENROLLMENT
  • CERTIFICATION_UNENROLLMENT

除了这些事件之外，还有一些批量取消注册事件。 每当管理员、经理或平台标记取消注册时，系统都会触发非实时取消注册事件。 根据学习对象类型，批量取消注册事件可以是以下之一：

  • COURSE_UNENROLLMENT_BATCH
  • LEARNING_PATH_UNENROLLMENT_BATCH
  • CERTIFICATION_UNENROLLMENT_BATCH

完成

学习者完成学习对象时，系统即会触发实时完成事件。 根据学习对象类型，实时完成事件可分为以下类别之一：

  • COURSE_COMPLETED
  • LEARNING_PATH_COMPLETED
  • CERTIFICATION_COMPLETED

除了这些实时事件之外，还有批量完成事件。 例如，当管理员、经理或平台将学习对象标记为完成时，将触发非实时完成事件。 根据学习对象类型，批量完成事件可分为以下类别之一：

  • COURSE_COMPLETED_BATCH
  • LEARNING_PATH_COMPLETED_BATCH
  • CERTIFICATION_COMPLETED_BATCH

学习者进度

每当学习者注册学习对象并开始模块时，系统都会跟踪其进度。 此数据包含在​ LEARNER_PROGRESS ​事件中。 由于进度跟踪依赖于复杂的聚合逻辑（非实时），因此事件可能会延迟多达15分钟。

CI统计信息

只要课程实例的名额或轮候表可用性发生变化，就会触发​ CI_STATS ​实时事件。 仅在实例级别捕获此数据。 此外，此事件仅针对课程触发，而不针对其他学习路径或认证触发，因为名额和轮候表可用性是课程及其实例的特定属性。

事件顺序

Adobe Learning Manager可确保为每个帐户排列事件。 但是，在关联注册或完成与进度事件之间的报文时可能存在差异。 发生这种情况的原因是，学习者进度事件最多可延迟15分钟，因为进度跟踪依赖于复杂的聚合逻辑，而后者不是实时的。 此外，进度事件来自不同的数据源，因此不能保证其顺序与注册和完成事件相关。 因此，Adobe Learning Manager在客户端侦听这些事件时提供了最佳做法。

如果完成事件发生在学习者进度事件之前，则客户端可以忽略学习者进度事件。 这是因为学习者进度事件最多可延迟15分钟，而完成事件可能在收到进度事件之前触发。 由于收到完成事件即表示学习对象已完成，因此进度已达到100%。

在极少数情况下，注册事件会在学习者进度事件之后发生，客户端可以忽略注册事件。 这是因为只有在学习者注册学习对象后才能跟踪进度。 换言之，收到进度事件表示学习对象已开始，且仅在成功注册后发生。