Skip to main content
Ctrl+K
Open edX Events latest documentation - Home Open edX Events latest documentation - Home

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
    • 0018: Supporting Subdomain Modules for Cross-Domain Events
  • Repository
  • Suggest edit
  • Open issue
  • .rst

Architectural Decision Records (ADRs)

Architectural Decision Records (ADRs)#

Contents:

  • 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
  • 0018: Supporting Subdomain Modules for Cross-Domain Events

previous

Using Open edX Events in the LMS Service

next

1. Purpose of this Repo

By Open edX Community

© Copyright 2023, Open edX Community.

Creative Commons License
These works by Axim Collaborative, Inc are licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.