Welcome to Open edX Events’ Documentation!

Open edX Events is a type of hook in the Hooks Extension Framework that allows extending the Open edX platform in a more stable and maintainable way. If you are new to this approach for extending Open edX, start by reading the Hooks Extension Framework documentation. This documentation provides an overview of the framework’s concepts and structure, which are useful to support your adoption of Open edX Events.

This repository contains all the references, concepts, how-tos, quickstarts and Architectural Decision Records (ADRs) related to the Open edX Events necessary to implement this hook in your instance.

Contents:

• Concepts
  • Open edX Events
  • Open edX Event Bus
• References
  • Open edX Events Tooling
  • Open edX Events Data Attributes
  • Events
  • In-line Code Annotations for an Open edX Event
  • Open edX Events Glossary
  • Event Bus Configuration
  • Open edX Proposals
  • Architecture Subdomains
  • Real-Life Use Cases for Open edX Events
  • Naming Suggestions for Open edX Events
• How-tos
  • Create a New Open edX Event with Long-Term Support
  • Consume an Open edX Event
  • Add Event Bus Support to an Open edX Event
  • Use the Open edX Event Bus to Broadcast and Consume Events
  • Add a New Concrete Implementation of the Event Bus
• Quickstarts
  • Using Open edX Events in the LMS Service
• Architectural Decision Records (ADRs)
  • 1. Purpose of this Repo
  • 2. Open edX events naming and versioning
  • 3. Open edX events payload conventions
  • 4. External event bus and Django Signal events
  • 5. External Event Schema Format
  • 6. Event schema serialization and evolution
  • 7. Optional fields in events
  • 8. Event signals with PII
  • 9. Event design of the COURSE_CATALOG_INFO_CHANGED signal
  • 10. Multiple event types per topic
  • 11. Depending on multiple event bus implementations
  • 12. Enable producing to event bus via settings
  • 13. Event definitions for special exam post-submission and review
  • 14. Change event producer config settings
  • 15. Outbox pattern and production modes
  • 16. Event Design Best Practices
  • 17. Event Signal for External Grader Score Submission