Welcome to Open edX Events’ documentation!

Contents:

• Concepts
  • Openedx Hooks Extension Framework
• 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
• How-tos
  • How to create a new Open edX Event
  • How to add an Open edX Event to a service
  • Using the Open edX Event bus
  • Using Open edX Events
  • How to add a new concrete implementation of the event bus
• Quickstarts
  • Using Open edX Events in the LMS service
• References
  • Events
  • Open edX Proposals
  • Architecture Subdomains