Skip to content

docs: update event routing #533

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
saraburns1 merged 2 commits into from
Nov 18, 2025
Merged

docs: update event routing #533

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0575a26
docs: rename files to lowercase
saraburns1 Nov 17, 2025
ade4e9c
docs: change to Open edX
saraburns1 Nov 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 ...oncepts/event-mapping/Caliper_mapping.rst → ...oncepts/event-mapping/caliper_mapping.rst
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/technical_documentation/concepts/event-mapping/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ Event Mapping
.. toctree::
:maxdepth: 1

caliper_mapping
supported_events
caliper_mapping
xapi_mapping
5 changes: 3 additions & 2 deletions ...ncepts/event-mapping/Supported_events.rst → ...ncepts/event-mapping/supported_events.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Video events
* `edx.video.stopped`_ (legacy name: ``stop_video``) | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/stop_video.json>`__ | xAPI :ref:`map <technical_documentation/concepts/event-mapping/xapi_mapping:edx.video.stopped>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/stop_video.json>`__ | Caliper :ref:`map <technical_documentation/concepts/event-mapping/caliper_mapping:edx.video.stopped>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/caliper/tests/fixtures/expected/stop_video.json>`__
* `edx.video.paused`_ (legacy name: ``pause_video``) | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/pause_video.json>`__ | xAPI :ref:`map <technical_documentation/concepts/event-mapping/xapi_mapping:edx.video.paused>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/pause_video.json>`__ | Caliper :ref:`map <technical_documentation/concepts/event-mapping/caliper_mapping:edx.video.paused>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/caliper/tests/fixtures/expected/pause_video.json>`__
* `edx.video.position.changed`_ (legacy name: ``seek_video``) | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/seek_video.json>`__ | xAPI :ref:`map <technical_documentation/concepts/event-mapping/xapi_mapping:edx.video.position.changed>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/seek_video.json>`__ | Caliper :ref:`map <technical_documentation/concepts/event-mapping/caliper_mapping:edx.video.position.changed>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/caliper/tests/fixtures/expected/seek_video.json>`__
* complete_video | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/complete_video.json>`__ | xAPI :ref:`map <technical_documentation/concepts/event-mapping/xapi_mapping:complete_video>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/complete_video.json>`__ | Caliper :ref:`map <technical_documentation/concepts/event-mapping/caliper_mapping:complete_video>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/caliper/tests/fixtures/expected/complete_video.json>`__
* edx.video.completed (legacy name: ``complete_video``) | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/complete_video.json>`__ | xAPI :ref:`map <technical_documentation/concepts/event-mapping/xapi_mapping:complete_video>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/complete_video.json>`__ | Caliper :ref:`map <technical_documentation/concepts/event-mapping/caliper_mapping:complete_video>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/caliper/tests/fixtures/expected/complete_video.json>`__
* `edx.video.closed_captions.shown`_ (legacy name: ``video_show_cc_menu``) | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/video_show_cc_menu.json>`__ | xAPI :ref:`map <technical_documentation/concepts/event-mapping/xapi_mapping:edx.video.closed_captions.shown>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/video_show_cc_menu.json>`__ | Caliper :ref:`map <technical_documentation/concepts/event-mapping/caliper_mapping:edx.video.closed_captions.shown>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/caliper/tests/fixtures/expected/video_show_cc_menu.json>`__
* `edx.video.closed_captions.hidden`_ (legacy name: ``video_hide_cc_menu``) | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/video_hide_cc_menu.json>`__ | xAPI :ref:`map <technical_documentation/concepts/event-mapping/xapi_mapping:edx.video.closed_captions.hidden>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/video_hide_cc_menu.json>`__ | Caliper :ref:`map <technical_documentation/concepts/event-mapping/caliper_mapping:edx.video.closed_captions.hidden>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/caliper/tests/fixtures/expected/video_hide_cc_menu.json>`__
* `edx.video.transcript.shown`_ (legacy name: ``show_transcript``) | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/show_transcript.json>`__ | xAPI :ref:`map <technical_documentation/concepts/event-mapping/xapi_mapping:edx.video.transcript.shown>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/show_transcript.json>`__ | Caliper :ref:`map <technical_documentation/concepts/event-mapping/caliper_mapping:edx.video.transcript.shown>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/caliper/tests/fixtures/expected/show_transcript.json>`__
Expand All @@ -52,7 +52,7 @@ Video events
Course navigation events
------------------------

* `edx.ui.lms.sequence.outline.selected`_ | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/edx.ui.lms.outline.selected.json>`__ | xAPI :ref:`map <technical_documentation/concepts/event-mapping/xapi_mapping:edx.ui.lms.sequence.outline.selected>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/edx.ui.lms.outline.selected.json>`__ | Caliper :ref:`map <technical_documentation/concepts/event-mapping/caliper_mapping:edx.ui.lms.sequence.outline.selected>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/caliper/tests/fixtures/expected/edx.ui.lms.outline.selected.json>`__
* `edx.ui.lms.sequence.outline.selected`_ (also ``edx.ui.lms.outline.selected``) | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/edx.ui.lms.outline.selected.json>`__ | xAPI :ref:`map <technical_documentation/concepts/event-mapping/xapi_mapping:edx.ui.lms.sequence.outline.selected>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/edx.ui.lms.outline.selected.json>`__ | Caliper :ref:`map <technical_documentation/concepts/event-mapping/caliper_mapping:edx.ui.lms.sequence.outline.selected>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/caliper/tests/fixtures/expected/edx.ui.lms.outline.selected.json>`__
* `edx.ui.lms.sequence.next_selected`_ | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/edx.ui.lms.sequence.next_selected.json>`__ | xAPI :ref:`map <technical_documentation/concepts/event-mapping/xapi_mapping:edx.ui.lms.sequence.next_selected>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/edx.ui.lms.sequence.next_selected.json>`__ | Caliper :ref:`map <technical_documentation/concepts/event-mapping/caliper_mapping:edx.ui.lms.sequence.next_selected>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/caliper/tests/fixtures/expected/edx.ui.lms.sequence.next_selected.json>`__
* `edx.ui.lms.sequence.previous_selected`_ | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/edx.ui.lms.sequence.previous_selected.json>`__ | xAPI :ref:`map <technical_documentation/concepts/event-mapping/xapi_mapping:edx.ui.lms.sequence.previous_selected>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/edx.ui.lms.sequence.previous_selected.json>`__ | Caliper :ref:`map <technical_documentation/concepts/event-mapping/caliper_mapping:edx.ui.lms.sequence.previous_selected>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/caliper/tests/fixtures/expected/edx.ui.lms.sequence.previous_selected.json>`__
* `edx.ui.lms.sequence.tab_selected`_ | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/edx.ui.lms.sequence.tab_selected.json>`__ | xAPI :ref:`map <technical_documentation/concepts/event-mapping/xapi_mapping:edx.ui.lms.sequence.tab_selected>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/edx.ui.lms.sequence.tab_selected.json>`__ | Caliper :ref:`map <technical_documentation/concepts/event-mapping/caliper_mapping:edx.ui.lms.sequence.tab_selected>`, `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/caliper/tests/fixtures/expected/edx.ui.lms.sequence.tab_selected.json>`__
Expand Down Expand Up @@ -87,6 +87,7 @@ Exam events
* `edx.special_exam.timed.attempt.submitted`_ | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/edx.special_exam.timed.attempt.submitted.json>`__ | xAPI `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/edx.special_exam.timed.attempt.submitted.json>`__
* `edx.special_exam.proctored.attempt.created`_ | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/edx.special_exam.proctored.attempt.created.json>`__ | xAPI `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/edx.special_exam.proctored.attempt.created.json>`__
* `edx.special_exam.proctored.attempt.submitted`_ | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/edx.special_exam.proctored.attempt.submitted.json>`__ | xAPI `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/edx.special_exam.proctored.attempt.submitted.json>`__
* `edx.special_exam.practice.attempt.created`_ | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/edx.special_exam.practice.attempt.created.json>`__ | xAPI `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/edx.special_exam.practice.attempt.created.json>`__
* `edx.special_exam.practice.attempt.submitted`_ | edX `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/tests/fixtures/current/edx.special_exam.practice.attempt.submitted.json>`__ | xAPI `sample <https://github.com/openedx/event-routing-backends/blob/master/event_routing_backends/processors/xapi/tests/fixtures/expected/edx.special_exam.practice.attempt.submitted.json>`__

.. _edx.course.enrollment.activated: https://docs.openedx.org/en/latest/developers/references/internal_data_formats/tracking_logs/student_event_types.html#edx-course-enrollment-activated-and-edx-course-enrollment-deactivated
Expand Down
0 ...n/concepts/event-mapping/xAPI_mapping.rst → ...n/concepts/event-mapping/xapi_mapping.rst
View file
Open in desktop
File renamed without changes.