Webhooks使用指南

最後更新： 2024年11月15日

Webhook是網頁應用程式之間自動且即時通訊的一種方式。

傳統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%。

在註冊事件發生在學習者進度事件之後的罕見情況下，使用者端可以忽略註冊事件。 這是因為進度只能在學習者註冊學習物件後追蹤。 換言之，接收進度事件表示學習物件已開始，這只有在成功註冊後才會發生。