Skip to content

Commit 84c4639

Browse files
docs: add note about django plugins
1 parent e540e29 commit 84c4639

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

docs/how-tos/consume-an-event.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,8 @@ An :term:`Event Receiver` is simply a function that listens for a specific event
7171
- This event has a single field called ``enrollment`` which is an instance of the ``CourseEnrollmentData`` class. You can review the ``CourseEnrollmentData`` class to understand the data that is available to you and how you can use it to implement the custom logic.
7272
- The ``metadata`` parameter contains the Open edX-specific metadata for the event, such as the event version and timestamp when the event was sent. You can use this metadata to understand more about the event and its context.
7373

74+
These event receivers are implemented in `Open edX Django plugins`_ and are registered in the ``signals.py`` file of the plugin. You can review the ``signals.py`` file of the openedx-events-2-zapier_ plugin to understand how the event receivers are implemented and connected to the events.
75+
7476
Step 4: Test the Event Receiver
7577
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7678

@@ -117,3 +119,4 @@ This way you can ensure that the event receiver is working as expected and that
117119
.. _Tutor: https://docs.tutor.edly.io/
118120
.. _Django Signals Documentation: https://docs.djangoproject.com/en/4.2/topics/signals/
119121
.. _openedx-events-2-zapier: https://github.com/eduNEXT/openedx-events-2-zapier
122+
.. _Open edX Django plugins: https://docs.openedx.org/en/latest/developers/concepts/platform_overview.html#new-plugin

0 commit comments

Comments
 (0)