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: authz#
Subject: role_assignment#
org.openedx.authz.role_assignment.created#
Description: Emitted when a role assignment is created in Open edX.
Signal name: ROLE_ASSIGNMENT_CREATED
Event key field: user.pii.username
Event data: RoleAssignmentData
Defined at: openedx_events/authz/signals.py (line 11)
Triggered by:
org.openedx.authz.role_assignment.deleted#
Description: Emitted when a role assignment is deleted in Open edX.
Signal name: ROLE_ASSIGNMENT_DELETED
Event key field: user.pii.username
Event data: RoleAssignmentData
Defined at: openedx_events/authz/signals.py (line 25)
Triggered by:
Architectural subdomain: enterprise#
Subject: enterprise_group#
org.openedx.enterprise.enterprise_group.deleted.v1#
Description: emitted when an EnterpriseGroup is deleted.
Signal name: ENTERPRISE_GROUP_DELETED
Event data: EnterpriseGroup
Defined at: openedx_events/enterprise/signals.py (line 122)
Triggered by:
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 102)
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 19)
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 32)
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 60)
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 46)
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 74)
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 88)
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 49)
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 420)
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 433)
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 407)
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 131)
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 105)
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 144)
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 170)
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 77)
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 63)
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 365)
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 394)
Triggered by:
org.openedx.learning.course.persistent_grade_summary.changed.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 197)
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 91)
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 183)
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 273)
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 249)
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 285)
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 237)
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 261)
Triggered by:
Subject: external_grader#
org.openedx.learning.external_grader.score.submitted.v1#
Description: emitted when an external grader provides a score for a submission
Signal name: EXTERNAL_GRADER_SCORE_SUBMITTED
Event data: ExternalGraderScoreData
Defined at: openedx_events/learning/signals.py (line 498)
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 322)
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 350)
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 336)
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 472)
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 446)
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 485)
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 459)
Triggered by:
Subject: lti_provider#
org.openedx.learning.lti_provider.launch.success.v1#
Description: emitted when a student accesses learning content via LTI
Signal name: LTI_PROVIDER_LAUNCH_SUCCESS
Event data: LtiProviderLaunchData
Defined at: openedx_events/learning/signals.py (line 510)
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 380)
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 118)
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 157)
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 35)
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 297)
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 309)
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: UserNotificationData
Defined at: openedx_events/learning/signals.py (line 223)
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 210)
Triggered by:
Maintenance chart
Review Date |
Reviewer |
Release |
Test situation |
2025-02-05 |
Maria Grimaldi |
Sumac |
Pass. |