Events

Contents

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: content_authoring#

Subject: content#

org.openedx.content_authoring.content.object.associations.changed.v1#

Description: Emitted when an object’s associations are changed, e.g tags, collections

Signal name: CONTENT_OBJECT_ASSOCIATIONS_CHANGED

Event data: ContentObjectChangedData

Defined at: openedx_events/content_authoring/signals.py (line 239)

Triggered by:

org.openedx.content_authoring.content.object.tags.changed.v1#

Description: Emitted when an object’s tags are changed.

Signal name: CONTENT_OBJECT_TAGS_CHANGED

Event data: ContentObjectData

Defined at: openedx_events/content_authoring/signals.py (line 251)

Warning

**DEPRECATED** please use CONTENT_OBJECT_ASSOCIATIONS_CHANGED instead.

Subject: content_library#

org.openedx.content_authoring.content_library.collection.created.v1#

Description: Emitted when a content library collection is created.

Signal name: LIBRARY_COLLECTION_CREATED

Event data: LibraryCollectionData

Defined at: openedx_events/content_authoring/signals.py (line 263)

Triggered by:

org.openedx.content_authoring.content_library.collection.deleted.v1#

Description: Emitted when an when a content library collection is deleted.

Signal name: LIBRARY_COLLECTION_DELETED

Event data: LibraryCollectionData

Defined at: openedx_events/content_authoring/signals.py (line 287)

Triggered by:

org.openedx.content_authoring.content_library.collection.updated.v1#

Description: Emitted when when a content library collection is updated.

Signal name: LIBRARY_COLLECTION_UPDATED

Event data: LibraryCollectionData

Defined at: openedx_events/content_authoring/signals.py (line 275)

Triggered by:

org.openedx.content_authoring.content_library.container.created.v1#

Description: Emitted when a content library container is created.

Signal name: LIBRARY_CONTAINER_CREATED

Event data: LibraryContainerData

Defined at: openedx_events/content_authoring/signals.py (line 299)

Triggered by:

org.openedx.content_authoring.content_library.container.deleted.v1#

Description: Emitted when an when a content library container is deleted.

Signal name: LIBRARY_CONTAINER_DELETED

Event data: LibraryContainerData

Defined at: openedx_events/content_authoring/signals.py (line 323)

Triggered by:

org.openedx.content_authoring.content_library.container.published.v1#

Description: Emitted when a library container is published. Also when a library container draft is deleted and then the deletion is published.

Signal name: LIBRARY_CONTAINER_PUBLISHED

Event data: LibraryContainerData

Defined at: openedx_events/content_authoring/signals.py (line 335)

Triggered by:

org.openedx.content_authoring.content_library.container.updated.v1#

Description: Emitted when when a content library container is updated.

Signal name: LIBRARY_CONTAINER_UPDATED

Event data: LibraryContainerData

Defined at: openedx_events/content_authoring/signals.py (line 311)

Triggered by:

org.openedx.content_authoring.content_library.created.v1#

Description: Emitted when a content library is created.

Signal name: CONTENT_LIBRARY_CREATED

Event data: ContentLibraryData

Defined at: openedx_events/content_authoring/signals.py (line 149)

Triggered by:

org.openedx.content_authoring.content_library.deleted.v1#

Description: Emitted when a content library is deleted.

Signal name: CONTENT_LIBRARY_DELETED

Event data: ContentLibraryData

Defined at: openedx_events/content_authoring/signals.py (line 178)

Triggered by:

org.openedx.content_authoring.content_library.updated.v1#

Description: Emitted when a content library is updated, such as its name is changed. This is NOT sent when the only changes are to items within the library, even though that affects the “last updated” and potentially “last published” or “has unpublished changes” aspects of the library overall. To detect those, subscribe to the detailed LIBRARY_* events.

Signal name: CONTENT_LIBRARY_UPDATED

Event data: ContentLibraryData

Defined at: openedx_events/content_authoring/signals.py (line 161)

Triggered by:

Subject: course#

org.openedx.content_authoring.course.catalog_info.changed.v1#

Description: Fired when a course changes in Studio in a way that is relevant for catalog consumers.

Signal name: COURSE_CATALOG_INFO_CHANGED

Event key field: catalog_info.course_key

Event data: CourseCatalogData

Defined at: openedx_events/content_authoring/signals.py (line 25)

Triggered by:

org.openedx.content_authoring.course.certificate_config.changed.v1#

Description: Fired when a course certificate configuration changes in Studio.

Signal name: COURSE_CERTIFICATE_CONFIG_CHANGED

Event data: CertificateConfigData

Defined at: openedx_events/content_authoring/signals.py (line 111)

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.content_authoring.course.certificate_config.deleted.v1#

Description: Fired when a course certificate configuration deletes in Studio.

Signal name: COURSE_CERTIFICATE_CONFIG_DELETED

Event data: CertificateConfigData

Defined at: openedx_events/content_authoring/signals.py (line 124)

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.content_authoring.course.created.v1#

Description: Emitted when a course is created.

Signal name: COURSE_CREATED

Event data: CourseData

Defined at: openedx_events/content_authoring/signals.py (line 137)

Triggered by:

org.openedx.content_authoring.course.import.completed.v1#

Description: Fired after a course is imported

Signal name: COURSE_IMPORT_COMPLETED

Event key field: catalog_info.course_key

Event data: CourseData

Defined at: openedx_events/content_authoring/signals.py (line 348)

Triggered by:

Subject: library_block#

org.openedx.content_authoring.library_block.created.v1#

Description: Emitted when a library XBlock is created.

Signal name: LIBRARY_BLOCK_CREATED

Event data: LibraryBlockData

Defined at: openedx_events/content_authoring/signals.py (line 190)

Triggered by:

org.openedx.content_authoring.library_block.deleted.v1#

Description: Emitted when a library XBlock (draft) is deleted.

Signal name: LIBRARY_BLOCK_DELETED

Event data: LibraryBlockData

Defined at: openedx_events/content_authoring/signals.py (line 214)

Triggered by:

org.openedx.content_authoring.library_block.published.v1#

Description: Emitted when a library XBlock is published. Also when a library block draft is deleted and then the deletion is published.

Signal name: LIBRARY_BLOCK_PUBLISHED

Event data: LibraryBlockData

Defined at: openedx_events/content_authoring/signals.py (line 226)

Triggered by:

org.openedx.content_authoring.library_block.updated.v1#

Description: Emitted when a library XBlock (draft) is updated.

Signal name: LIBRARY_BLOCK_UPDATED

Event data: LibraryBlockData

Defined at: openedx_events/content_authoring/signals.py (line 202)

Triggered by:

Subject: xblock#

org.openedx.content_authoring.xblock.created.v1#

Description: Fired when an XBlock is created.

Signal name: XBLOCK_CREATED

Event key field: xblock_info.usage_key

Event data: XBlockData

Defined at: openedx_events/content_authoring/signals.py (line 38)

Triggered by:

org.openedx.content_authoring.xblock.deleted.v1#

Description: Fired when an XBlock is deleted.

Signal name: XBLOCK_DELETED

Event key field: xblock_info.usage_key

Event data: XBlockData

Defined at: openedx_events/content_authoring/signals.py (line 83)

Triggered by:

org.openedx.content_authoring.xblock.duplicated.v1#

Description: Fired when an XBlock is duplicated in Studio.

Signal name: XBLOCK_DUPLICATED

Event key field: xblock_info.usage_key

Event data: DuplicatedXBlockData

Defined at: openedx_events/content_authoring/signals.py (line 97)

Triggered by:

org.openedx.content_authoring.xblock.published.v1#

Description: Fired when an XBlock is published. If a parent block with changes in one or more child blocks is published, only a single XBLOCK_PUBLISHED event is fired with parent block details. For example: If a section is published with changes in multiple units, only a single event is fired with section details like : `XBlockData(usage_key=”section-usage-key”, block_type=”chapter”)`

Signal name: XBLOCK_PUBLISHED

Event key field: xblock_info.usage_key

Event data: XBlockData

Defined at: openedx_events/content_authoring/signals.py (line 64)

Triggered by:

org.openedx.content_authoring.xblock.updated.v1#

Description: Fired when an XBlock is updated.

Signal name: XBLOCK_UPDATED

Event key field: xblock_info.usage_key

Event data: XBlockData

Defined at: openedx_events/content_authoring/signals.py (line 51)

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 48)

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 419)

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 432)

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 406)

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 130)

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 104)

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 143)

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 169)

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 76)

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 62)

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 364)

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 393)

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 196)

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 90)

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 182)

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 272)

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 248)

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 284)

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 236)

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 260)

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 497)

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 321)

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 349)

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 335)

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 471)

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 445)

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 484)

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 458)

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 379)

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 117)

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 156)

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 34)

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 296)

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 308)

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 222)

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 209)

Triggered by:

Maintenance chart

Review Date

Reviewer

Release

Test situation

2025-02-05

Maria Grimaldi

Sumac

Pass.
Contents