A ready-to-use repository demonstrating how to use Open edX Events for building workflows and automating integrations. It serves as a starting point for more advanced use cases. Explore Real-Life Use Cases for Open edX Events to see more complex implementations from the Open edX Community
This repository demonstrates how to connect Open edX registration, enrollment, and grade change events to external tools via Zapier, enabling easier automation workflows through this third-party service.
Open edX Events are a powerful feature that allows developers to listen to key events in the Open edX platform and trigger custom actions based on them. This can be useful for a variety of use cases, such as:
- Sending welcome emails to new users
- Logging new enrollments to external CRMs
- Triggering events like email follow-ups for grade updates
By sending key event data to Zapier, Open edX users can leverage the integration ecosystem of Zapier without additional development effort.
Please see the Open edX documentation for guidance on Python development in this repo.
See the Usage section below for instructions on how to deploy this plugin. Also, see the Tutor documentation for more information on deploying extra requirements.
Refer to the Open edX Events documentation to learn about implementing and working with events. This documentation details how to use the repository to integrate with third-party services, such as Zapier Webhooks, through events.
- Event Handlers: Listen to Open edX Events using Django signals and send data to Zapier.
- Webhook Integration: Send event data to Zapier webhooks for further processing.
- Customizable: Easily extend the repository to handle additional events or integrate with other services.
- Ready-to-Use: Install the package and configure webhooks to start sending events to Zapier.
| Event Name | Event Type | Description |
|---|---|---|
| STUDENT_REGISTRATION_COMPLETED | org.openedx.learning.student.registration.completed.v1 | Triggered when a user completes registration in the LMS. |
| COURSE_ENROLLMENT_CREATED | org.openedx.learning.course.enrollment.created.v1 | Triggered upon successful course enrollment. |
| PERSISTENT_GRADE_SUMMARY_CHANGED | org.openedx.learning.course.persistent_grade.summary.v1 | Triggered when a persistent grade summary is updated. This happens when a grade changes in a course. |
Each of the above events is handled by Django Signal handlers. When these signals are emitted, they are intercepted by handlers defined in the repository, which transform and forward the event data to a Zapier webhook.
In the file handlers.py, handlers listen to Django signals using the standard receiver decorator:
from django.dispatch import receiver
from openedx_events.signals import STUDENT_REGISTRATION_COMPLETED
@receiver(STUDENT_REGISTRATION_COMPLETED)
def send_user_data_to_webhook(signal, sender, user, metadata, **kwargs):
zapier_payload = {
"user": asdict(user),
"event_metadata": asdict(metadata),
}
requests.post(
settings.ZAPIER_REGISTRATION_WEBHOOK,
flatten_dict(zapier_payload),
timeout=ZAPIER_REQUEST_TIMEOUT,
)- The
receiverdecorator listens to theSTUDENT_REGISTRATION_COMPLETEDsignal. - The handler function
send_user_data_to_webhookextracts the user and metadata from the signal. - The
ZAPIER_REGISTRATION_WEBHOOKURL is configured as a Django settings by using a Tutor plugin. - The extracted data is formatted into a payload and sent to the Zapier webhook for further processing.
The Django app is configured using an AppConfig to automatically register handlers on startup.
class OpenedxEvents2ZapierConfig(AppConfig):
name = "openedx_events_2_zapier"
def ready(self):
from openedx_events_2_zapier import handlersTo use this plugin, follow these steps:
- Install the plugin in your Open edX image using Tutor's
OPENEDX_EXTRA_PIP_REQUIREMENTSconfiguration setting:
OPENEDX_EXTRA_PIP_REQUIREMENTS:
- git+https://github.com/edunext/[email protected]- Launch the Open edX platform to apply the changes:
tutor local launch- Create and enable an Inline Tutor plugin to configure the Zapier webhooks:
# Location plugins/zapier.py
from tutor import hooks
hooks.Filters.ENV_PATCHES.add_item(
(
"openedx-lms-common-settings",
"""
ZAPIER_REGISTRATION_WEBHOOK = "https://hooks.zapier.com/hooks/catch/<account>/<webhook>/"
ZAPIER_ENROLLMENT_WEBHOOK = "https://hooks.zapier.com/hooks/catch/<account>/<webhook>/"
ZAPIER_GRADE_WEBHOOK = "https://hooks.zapier.com/hooks/catch/<account>/<webhook>/"
"""
)
)tutor plugins enable zapier- Configure Zapier webhooks to receive the event data, follow the instructions available in the Zapier documentation.
- Trigger the events by registering a new user, enrolling in a course, or updating a grade in the Open edX platform.
To send event data to other services or APIs, simply configure more webhooks in the Django settings. The handlers are intentionally generic, ensuring they work seamlessly with different kinds of services. You can also add more event handlers to the handlers.py file to listen to additional events.
This repository is a starting point for Open edX developers:
- You can add new event handlers by following the structure in handlers.py.
- Custom logic can be implemented to fit your organization's data flow requirements using Zapier, third-party APIs, or internal services.
For details on extending Open edX with Open edX Events, see also:
The openedx-events-2-zapier repository is here to make integrations simple and sustainable, giving developers the tools to create effective Open edX workflows with external services like Zapier.
If you're having trouble, we have discussion forums at https://discuss.openedx.org where you can connect with others in the community.
Our real-time conversations are on Slack. You can request a Slack invitation, then join our community Slack workspace.
For anything non-trivial, the best path is to open an issue in this repository with as many details about the issue you are facing as you can provide.
https://github.com/edunext/openedx-events-2-zapier/issues
For more information about these options, see the Getting Help page.
The code in this repository is licensed under the AGPL 3.0 unless otherwise noted.
Please see LICENSE.txt for details.
Contributions are very welcome. Please read How To Contribute for details.
This project is currently accepting all types of contributions, bug fixes, security fixes, maintenance work, or new features. However, please make sure to discuss your new feature idea with the maintainers before beginning development to maximize the chances of your change being accepted. You can start a conversation by creating a new issue on this repo summarizing your idea.
All community members are expected to follow the Open edX Code of Conduct.
This repository is currently being maintained by the eduNEXT team. See the CODEOWNERS file for details.
Please do not report security issues in public. Please email [email protected].