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 event is emitted.
Signal name: TRACKING_EVENT_EMITTED
Event key field: tracking_log.name
Event data: TrackingLogData
Defined at: openedx_events/analytics/signals.py (line 14)
Triggered by:
Architectural subdomain: enterprise#
Subject: learner_credit_course_enrollment#
org.openedx.enterprise.learner_credit_course_enrollment.revoked.v1#
Description: emitted when a LearnerCreditEnterpriseCourseEnrollment is revoked. This most often happens when an enterprise learner unenrolls from a course which was LC-subsidized.
Signal name: LEARNER_CREDIT_COURSE_ENROLLMENT_REVOKED
Event data: LearnerCreditEnterpriseCourseEnrollment
Defined at: openedx_events/enterprise/signals.py (line 97)
Triggered by:
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)
Warning
This event is not being currently used in any of the Open edX services. Review https://github.com/openedx/openedx-events/issues/445 for more information about the future of this event.
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 27)
Warning
This event is not being currently used in any of the Open edX services. Review https://github.com/openedx/openedx-events/issues/445 for more information about the future of this event.
Subject: subsidy_ledger_transaction#
org.openedx.enterprise.subsidy_ledger_transaction.committed.v1#
Description: emitted when an enterprise ledger transaction is committed. See: https://github.com/openedx/openedx-ledger/tree/main/docs/decisions
Signal name: LEDGER_TRANSACTION_COMMITTED
Event data: LedgerTransaction
Defined at: openedx_events/enterprise/signals.py (line 55)
Triggered by:
org.openedx.enterprise.subsidy_ledger_transaction.created.v1#
Description: emitted when an enterprise ledger transaction is created. See: https://github.com/openedx/openedx-ledger/tree/main/docs/decisions
Signal name: LEDGER_TRANSACTION_CREATED
Event data: LedgerTransaction
Defined at: openedx_events/enterprise/signals.py (line 41)
Triggered by:
org.openedx.enterprise.subsidy_ledger_transaction.failed.v1#
Description: emitted when an enterprise ledger transaction fails. See: https://github.com/openedx/openedx-ledger/tree/main/docs/decisions
Signal name: LEDGER_TRANSACTION_FAILED
Event data: LedgerTransaction
Defined at: openedx_events/enterprise/signals.py (line 69)
Triggered by:
org.openedx.enterprise.subsidy_ledger_transaction.reversed.v1#
Description: emitted when an enterprise ledger transaction is reversed. See: https://github.com/openedx/openedx-ledger/tree/main/docs/decisions
Signal name: LEDGER_TRANSACTION_REVERSED
Event data: LedgerTransaction
Defined at: openedx_events/enterprise/signals.py (line 83)
Triggered by:
Architectural subdomain: learning#
Subject: auth#
org.openedx.learning.auth.session.login.completed.v1#
Description: Emitted when a user logs in to Open edX.
Signal name: SESSION_LOGIN_COMPLETED
Event key field: user.pii.username
Event data: UserData
Defined at: openedx_events/learning/signals.py (line 47)
Triggered by:
Subject: badge#
org.openedx.learning.badge.awarded.v1#
Description: Emit when a badge is awarded to a learner.
Signal name: BADGE_AWARDED
Event data: BadgeData
Defined at: openedx_events/learning/signals.py (line 418)
Triggered by:
org.openedx.learning.badge.revoked.v1#
Description: Emit when a badge is revoked for a learner,
Signal name: BADGE_REVOKED
Event data: BadgeData
Defined at: openedx_events/learning/signals.py (line 431)
Triggered by:
Subject: ccx#
org.openedx.learning.ccx.course.passing.status.updated.v1#
Description: Emitted when a CCX course grade updates.
Signal name: CCX_COURSE_PASSING_STATUS_UPDATED
Event data: CcxCoursePassingStatusData
Defined at: openedx_events/learning/signals.py (line 405)
Triggered by:
Subject: certificate#
org.openedx.learning.certificate.changed.v1#
Description: Emitted when the user’s certificate changes.
Signal name: CERTIFICATE_CHANGED
Event data: CertificateData
Defined at: openedx_events/learning/signals.py (line 129)
Triggered by:
org.openedx.learning.certificate.created.v1#
Description: Emitted when a certificate is created for a user.
Signal name: CERTIFICATE_CREATED
Event key field: certificate.course.course_key
Event data: CertificateData
Defined at: openedx_events/learning/signals.py (line 103)
Triggered by:
org.openedx.learning.certificate.revoked.v1#
Description: Emitted when a certificate is revoked from a user.
Signal name: CERTIFICATE_REVOKED
Event key field: certificate.course.course_key
Event data: CertificateData
Defined at: openedx_events/learning/signals.py (line 142)
Triggered by:
Subject: cohort_membership#
org.openedx.learning.cohort_membership.changed.v1#
Description: Emitted when a user’s cohort membership changes.
Signal name: COHORT_MEMBERSHIP_CHANGED
Event data: CohortData
Defined at: openedx_events/learning/signals.py (line 168)
Triggered by:
Subject: course#
org.openedx.learning.course.enrollment.changed.v1#
Description: Emitted when the enrollment for a user in a course changes.
Signal name: COURSE_ENROLLMENT_CHANGED
Event key field: enrollment.course.course_key
Event data: CourseEnrollmentData
Defined at: openedx_events/learning/signals.py (line 75)
Triggered by:
org.openedx.learning.course.enrollment.created.v1#
Description: Emitted when the user enrolls in a course.
Signal name: COURSE_ENROLLMENT_CREATED
Event key field: enrollment.course.course_key
Event data: CourseEnrollmentData
Defined at: openedx_events/learning/signals.py (line 61)
Triggered by:
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 363)
Triggered by:
Warning
This event is currently incompatible with the event bus, dict without annotations are not serializable.
org.openedx.learning.course.passing.status.updated.v1#
Description: Emitted when course grade updates.
Signal name: COURSE_PASSING_STATUS_UPDATED
Event data: CoursePassingStatusData
Defined at: openedx_events/learning/signals.py (line 392)
Triggered by:
org.openedx.learning.course.persistent_grade.summary.v1#
Description: Emitted when a course’s persistent grade summary changes for a user.
Signal name: PERSISTENT_GRADE_SUMMARY_CHANGED
Event data: PersistentCourseGradeData
Defined at: openedx_events/learning/signals.py (line 195)
Triggered by:
org.openedx.learning.course.unenrollment.completed.v1#
Description: Emitted when the user unenrolls from a course.
Signal name: COURSE_UNENROLLMENT_COMPLETED
Event key field: enrollment.course.course_key
Event data: CourseEnrollmentData
Defined at: openedx_events/learning/signals.py (line 89)
Triggered by:
Subject: discussions#
org.openedx.learning.discussions.configuration.changed.v1#
Description: Emitted when the configuration for a course’s discussions changes in the course.
Signal name: COURSE_DISCUSSIONS_CHANGED
Event data: CourseDiscussionConfigurationData
Defined at: openedx_events/learning/signals.py (line 181)
Triggered by:
Warning
This event is currently incompatible with the event bus, list with complex types like ``List[DiscussionTopicContext]`` cannot be serialized yet.
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 271)
Triggered by:
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 247)
Triggered by:
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 283)
Triggered by:
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 235)
Triggered by:
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 259)
Triggered by:
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
Defined at: openedx_events/learning/signals.py (line 320)
Triggered by:
Warning
This event is currently incompatible with the event bus, dict without annotations are not serializable.
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
Defined at: openedx_events/learning/signals.py (line 348)
Triggered by:
Warning
This event is currently incompatible with the event bus, dict without annotations are not serializable.
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
Defined at: openedx_events/learning/signals.py (line 334)
Triggered by:
Warning
This event is currently incompatible with the event bus, dict without annotations are not serializable.
Subject: idv_attempt#
org.openedx.learning.idv_attempt.approved.v1#
Description: Emitted when an IDV attempt is approved.
Signal name: IDV_ATTEMPT_APPROVED
Event data: VerificationAttemptData
Defined at: openedx_events/learning/signals.py (line 470)
Triggered by:
org.openedx.learning.idv_attempt.created.v1#
Description: Emitted when an IDV attempt is created.
Signal name: IDV_ATTEMPT_CREATED
Event data: VerificationAttemptData
Defined at: openedx_events/learning/signals.py (line 444)
Triggered by:
org.openedx.learning.idv_attempt.denied.v1#
Description: Emitted when an IDV attempt is denied.
Signal name: IDV_ATTEMPT_DENIED
Event data: VerificationAttemptData
Defined at: openedx_events/learning/signals.py (line 483)
Triggered by:
org.openedx.learning.idv_attempt.pending.v1#
Description: Emitted when an IDV attempt is marked as pending.
Signal name: IDV_ATTEMPT_PENDING
Event data: VerificationAttemptData
Defined at: openedx_events/learning/signals.py (line 457)
Triggered by:
Subject: ora#
org.openedx.learning.ora.submission.created.v1#
Description: Emitted when a user submits an ORA assignment.
Signal name: ORA_SUBMISSION_CREATED
Event data: ORASubmissionData
Defined at: openedx_events/learning/signals.py (line 378)
Triggered by:
Warning
This event is currently incompatible with the event bus, list[dict] cannot be serialized yet.
Subject: program#
org.openedx.learning.program.certificate.awarded.v1#
Description: Emitted 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 116)
Triggered by:
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 155)
Triggered by:
Subject: student#
org.openedx.learning.student.registration.completed.v1#
Description: Emitted when a user completes registration in Open edX.
Signal name: STUDENT_REGISTRATION_COMPLETED
Event key field: user.pii.username
Event data: UserData
Defined at: openedx_events/learning/signals.py (line 33)
Triggered by:
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 295)
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 307)
Triggered by:
org.openedx.learning.user.notification.requested.v1#
Description: Can be emitted from apps to send user notifications.
Signal name: USER_NOTIFICATION_REQUESTED
Event data: UserNotificationSendListData
Defined at: openedx_events/learning/signals.py (line 221)
Triggered by:
Warning
This event is currently incompatible with the event bus, list without annotations are not serializable.
Subject: xblock#
org.openedx.learning.xblock.skill.verified.v1#
Description: Emitted 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 208)
Triggered by: