Events#
This is the list of Open edX events found in this repository.
Note
Events can be created in other projects and plugins as well, but these default events are guaranteed to exist.
Architectural subdomain: analytics#
Subject: tracking#
org.openedx.analytics.tracking.event.emitted.v1#
Description: emitted when a tracking log is created.
Signal name: TRACKING_EVENT_EMITTED
Event key field: tracking_log.name
Event data: TrackingLogData
Defined at: openedx_events/analytics/signals.py (line 14)
Architectural subdomain: enterprise#
Subject: subsidy#
org.openedx.enterprise.subsidy.redeemed.v1#
Description: emitted when an enterprise subsidy is utilized.
Signal name: SUBSIDY_REDEEMED
Event data: SubsidyRedemption
Defined at: openedx_events/enterprise/signals.py (line 14)
org.openedx.enterprise.subsidy.redemption-reversed.v1#
Description: emitted when an enterprise subsidy is reversed.
Signal name: SUBSIDY_REDEMPTION_REVERSED
Event data: SubsidyRedemption
Defined at: openedx_events/enterprise/signals.py (line 25)
Architectural subdomain: learning#
Subject: auth#
org.openedx.learning.auth.session.login.completed.v1#
Description: emitted when the user’s login process in the LMS is completed.
Signal name: SESSION_LOGIN_COMPLETED
Event key field: user.pii.username
Event data: UserData
Defined at: openedx_events/learning/signals.py (line 41)
Subject: certificate#
org.openedx.learning.certificate.changed.v1#
Description: emitted when the user’s certificate update process is completed.
Signal name: CERTIFICATE_CHANGED
Event data: CertificateData
Defined at: openedx_events/learning/signals.py (line 115)
org.openedx.learning.certificate.created.v1#
Description: emitted when the user’s certificate creation process is completed.
Signal name: CERTIFICATE_CREATED
Event key field: certificate.course.course_key
Event data: CertificateData
Defined at: openedx_events/learning/signals.py (line 91)
org.openedx.learning.certificate.revoked.v1#
Description: emitted when the user’s certificate annulation process is completed.
Signal name: CERTIFICATE_REVOKED
Event key field: certificate.course.course_key
Event data: CertificateData
Defined at: openedx_events/learning/signals.py (line 127)
Subject: cohort_membership#
org.openedx.learning.cohort_membership.changed.v1#
Description: emitted when the user’s cohort update is completed.
Signal name: COHORT_MEMBERSHIP_CHANGED
Event data: CohortData
Defined at: openedx_events/learning/signals.py (line 151)
Subject: course#
org.openedx.learning.course.enrollment.changed.v1#
Description: emitted when the user’s enrollment update process is completed.
Signal name: COURSE_ENROLLMENT_CHANGED
Event data: CourseEnrollmentData
Defined at: openedx_events/learning/signals.py (line 66)
org.openedx.learning.course.enrollment.created.v1#
Description: emitted when the user’s enrollment process is completed.
Signal name: COURSE_ENROLLMENT_CREATED
Event data: CourseEnrollmentData
Defined at: openedx_events/learning/signals.py (line 54)
org.openedx.learning.course.notification.requested.v1#
Description: Emitted when a notification is requested for a course
Signal name: COURSE_NOTIFICATION_REQUESTED
Event data: CourseNotificationData
Defined at: openedx_events/learning/signals.py (line 328)
org.openedx.learning.course.persistent_grade.summary.v1#
Description: emitted when a grade changes in the course
Signal name: PERSISTENT_GRADE_SUMMARY_CHANGED
Event data: PersistentCourseGradeData
Defined at: openedx_events/learning/signals.py (line 175)
org.openedx.learning.course.unenrollment.completed.v1#
Description: emitted when the user’s unenrollment process is completed.
Signal name: COURSE_UNENROLLMENT_COMPLETED
Event key field: enrollment.course.course_key
Event data: CourseEnrollmentData
Defined at: openedx_events/learning/signals.py (line 78)
Subject: discussions#
org.openedx.learning.discussions.configuration.changed.v1#
Description: emitted when the configuration for a course’s discussions changes in the course Warning: This event is currently incompatible with the event bus, list/dict cannot be serialized yet
Signal name: COURSE_DISCUSSIONS_CHANGED
Event data: CourseDiscussionConfigurationData
Defined at: openedx_events/learning/signals.py (line 163)
Subject: exam#
org.openedx.learning.exam.attempt.errored.v1#
Description: Emitted when a learner’s exam attempt errors out in edx-exams.
Signal name: EXAM_ATTEMPT_ERRORED
Event data: ExamAttemptData
Defined at: openedx_events/learning/signals.py (line 245)
org.openedx.learning.exam.attempt.rejected.v1#
Description: Emitted when an exam attempt is marked rejected in edx-exams.
Signal name: EXAM_ATTEMPT_REJECTED
Event data: ExamAttemptData
Defined at: openedx_events/learning/signals.py (line 223)
org.openedx.learning.exam.attempt.reset.v1#
Description: Emitted when an exam attempt is reset in edx-exams.
Signal name: EXAM_ATTEMPT_RESET
Event data: ExamAttemptData
Defined at: openedx_events/learning/signals.py (line 256)
org.openedx.learning.exam.attempt.submitted.v1#
Description: Emitted when an exam attempt is submitted by a learner in edx-exams.
Signal name: EXAM_ATTEMPT_SUBMITTED
Event data: ExamAttemptData
Defined at: openedx_events/learning/signals.py (line 212)
org.openedx.learning.exam.attempt.verified.v1#
Description: Emitted when an exam attempt is marked verified in edx-exams.
Signal name: EXAM_ATTEMPT_VERIFIED
Event data: ExamAttemptData
Defined at: openedx_events/learning/signals.py (line 234)
Subject: forum#
org.openedx.learning.forum.thread.created.v1#
Description: Emitted when a new thread is created in a discussion
Signal name: FORUM_THREAD_CREATED
Event data: DiscussionThreadData
Warning: This event is currently incompatible with the event bus, list/dict cannot be serialized yet
Defined at: openedx_events/learning/signals.py (line 291)
org.openedx.learning.forum.thread.response.comment.created.v1#
Description: Emitted when a new comment is added to a response
Signal name: FORUM_RESPONSE_COMMENT_CREATED
Event data: DiscussionThreadData
Warning: This event is currently incompatible with the event bus, list/dict cannot be serialized yet
Defined at: openedx_events/learning/signals.py (line 315)
org.openedx.learning.forum.thread.response.created.v1#
Description: Emitted when a new response is added to a thread
Signal name: FORUM_THREAD_RESPONSE_CREATED
Event data: DiscussionThreadData
Warning: This event is currently incompatible with the event bus, list/dict cannot be serialized yet
Defined at: openedx_events/learning/signals.py (line 303)
Subject: ora#
org.openedx.learning.ora.submission.created.v1#
Description: Emitted when a new ORA submission is created
Signal name: ORA_SUBMISSION_CREATED
Event data: ORASubmissionData
Defined at: openedx_events/learning/signals.py (line 342)
Subject: program#
org.openedx.learning.program.certificate.awarded.v1#
Description: Emit when a program certificate is awarded to a learner
Signal name: PROGRAM_CERTIFICATE_AWARDED
Event key field: program_certificate.program.uuid
Event data: ProgramCertificateData
Defined at: openedx_events/learning/signals.py (line 103)
org.openedx.learning.program.certificate.revoked.v1#
Description: Emit when a program certificate is revoked from a learner
Signal name: PROGRAM_CERTIFICATE_REVOKED
Event key field: program_certificate.program.uuid
Event data: ProgramCertificateData
Defined at: openedx_events/learning/signals.py (line 139)
Subject: student#
org.openedx.learning.student.registration.completed.v1#
Description: emitted when the user registration process in the LMS is completed.
Signal name: STUDENT_REGISTRATION_COMPLETED
Event data: UserData
Defined at: openedx_events/learning/signals.py (line 29)
Subject: user#
org.openedx.learning.user.course_access_role.added.v1#
Description: Emitted when a user is given a course access role.
Signal name: COURSE_ACCESS_ROLE_ADDED
Event key field: course_access_role_data.course_key
Event data: CourseAccessRoleData
Defined at: openedx_events/learning/signals.py (line 267)
org.openedx.learning.user.course_access_role.removed.v1#
Description: Emitted when a course access role is removed from a user.
Signal name: COURSE_ACCESS_ROLE_REMOVED
Event key field: course_access_role_data.course_key
Event data: CourseAccessRoleData
Defined at: openedx_events/learning/signals.py (line 279)
org.openedx.learning.user.notification.requested.v1#
Description: Can be fired from apps to send user notifications.
Signal name: USER_NOTIFICATION_REQUESTED
Event data: UserNotificationSendListData
Defined at: openedx_events/learning/signals.py (line 199)
Subject: xblock#
org.openedx.learning.xblock.skill.verified.v1#
Description: Fired when an XBlock skill is verified.
Signal name: XBLOCK_SKILL_VERIFIED
Event key field: xblock_info.usage_key
Event data: XBlockSkillVerificationData
Defined at: openedx_events/learning/signals.py (line 187)