Webhook 사용 안내서

2024년 11월 15일

Webhook은 웹 응용 프로그램이 실시간으로 자동으로 서로 통신하는 방법입니다.

사용자가 정보를 요청하면 대기하는 기존 API와 달리 실시간 API는 그 순간 데이터를 공유한다. Webhook은 실시간 API로 작동하며 지정된 이벤트가 발생할 때마다 데이터를 즉시 공유하도록 지원합니다.

개체로 이동

Webhook 이벤트를 이해하려면 먼저 관련 엔티티와 이러한 이벤트의 트리거 조건을 인식해야 합니다.

학습 객체

다음은 학습 객체(강의, 학습 경로 또는 인증)에 대해 지원되는 이벤트입니다.

초안

UI에서 학습 개체를 만들 때마다 학습 개체는 초안 모드로 시작됩니다. 이는 학습 객체가 아직 게시되지 않았으며 학습자에게 표시되지 않음을 의미합니다. 학습 개체가 초안으로 유지되는 한 LEARNING_OBJECT_DRAFT 이벤트가 트리거됩니다. 초안에 대한 연속 업데이트도 이 이벤트를 트리거합니다.

업데이트

학습 개체가 게시되면 상태가 초안 ​에서 게시됨(으)로 변경됩니다. 이 전환 중에 학습 개체가 초안 ​에서 게시(으)로 수정되고 있으므로 Webhook은 LEARNING_OBJECT_MODIFICATION 이벤트를 생성합니다. 이후의 모든 LO 수정 및 업데이트는 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_UNREGISTRATION
  • LEARNING_PATH_UNREGISTRATION
  • CERTIFICATION_UNENROLLMENT

이러한 이벤트 외에도 일괄 등록 취소 이벤트도 있습니다. 관리자, 관리자 또는 플랫폼에서 등록 취소를 표시할 때마다 비실시간 등록 취소 이벤트가 트리거됩니다. 학습 객체 유형에 따라 일괄 등록 취소 이벤트는 다음 중 하나가 될 수 있습니다.

  • COURSE_UNENROLLMENT_BATCH
  • LEARNING_PATH_UNENROLLMENT_BATCH
  • CERTIFICATION_UNENROLLMENT_BATCH

완료

실시간 완료 이벤트는 학습자가 학습 객체를 완료할 때마다 트리거됩니다. 학습 객체 유형에 따라 실시간 완료 이벤트는 다음 범주 중 하나에 해당할 수 있습니다.

  • COURSE_COMPLETED
  • LEARNING_PATH_COMPLETE
  • CERTIFICATION_COMPLETED

이러한 실시간 이벤트 외에도 일괄 완료 이벤트도 있습니다. 예를 들어, 책임자, 관리자 또는 플랫폼이 학습 객체를 완료로 표시하면 비실시간 완료 이벤트가 트리거됩니다. 학습 객체 유형에 따라 일괄 완료 이벤트는 다음 범주 중 하나에 속할 수 있습니다.

  • COURSE_COMPLETED_BATCH
  • LEARNING_PATH_COMPLETED_일괄 처리
  • CERTIFICATION_COMPLETED_BATCH