feat: add webhook endpoint for Open edX course staff enrollment#3372
Draft
Anas12091101 wants to merge 3 commits intomainfrom
Draft
feat: add webhook endpoint for Open edX course staff enrollment#3372Anas12091101 wants to merge 3 commits intomainfrom
Anas12091101 wants to merge 3 commits intomainfrom
Conversation
OpenAPI ChangesShow/hide ## Changes for v0.yaml:Unexpected changes? Ensure your branch is up-to-date with |
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
openedx/views.py
Outdated
Comment on lines
+119
to
+123
| enrollments, edx_request_success = create_run_enrollments( | ||
| user, | ||
| [course_run], | ||
| keep_failed_enrollments=True, | ||
| ) |
There was a problem hiding this comment.
Bug: The webhook endpoint returns a success response even when the Open edX enrollment API call fails, because it ignores the edx_request_success flag.
Severity: HIGH
Suggested Fix
The webhook view should check the edx_request_success boolean returned from create_run_enrollments. If edx_request_success is False, the view should return an appropriate error response (e.g., HTTP 500 or 400) instead of an HTTP 200 success response. This will signal to the caller that the end-to-end operation failed and a retry may be needed.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.
Location: openedx/views.py#L119-L123
Potential issue: The webhook endpoint in `openedx/views.py` calls
`create_run_enrollments` and captures both the created `enrollments` and the
`edx_request_success` status flag. However, the code only checks if `enrollments` is
truthy before returning an HTTP 200 "Enrollment successful" response. It never inspects
the `edx_request_success` flag. This means if the external Open edX API call fails, a
local enrollment record is still created (with `edx_enrolled=False`), but the webhook
incorrectly reports success. This leads to data inconsistency, as the calling system
believes the user is fully enrolled when they are not.
Did we get this right? 👍 / 👎 to inform future reviews.
Member
|
How/is this limited to course staff?
There are similar use cases for enrolling non-staff as auditors, for example a SPOC or beta-testers
|
Anas12091101
force-pushed
the
anas/implement-openedx-course-staff-webhook
branch
from
e7a2816 to
c1a9944
Compare
Anas12091101
commented
Mar 11, 2026
Comment on lines
+527
to
+531
| {enrollment.run.start_date | ||
| ? `Starts ${formatPrettyMonthDate( | ||
| parseDateString(enrollment.run.start_date) | ||
| )}` | ||
| : "Coming Soon"} |
Contributor
Author
There was a problem hiding this comment.
Enrollment in a course run with a null start date was breaking the dashboard page.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What are the relevant tickets?
https://github.com/mitodl/hq/issues/1209
Description (What does it do?)
This PR adds a webhook endpoint (/api/openedx_webhook/course_staff/) that receives course staff addition notifications from Open edX. When an instructor or staff member is added to a course in Open edX, the plugin POSTs the event to MITx Online, which then automatically enrolls the user as an auditor in the corresponding course run. The endpoint authenticates requests using a shared Bearer token (
OPENEDX_WEBHOOK_KEY) and handles user/course lookup, duplicate enrollment checks, and appropriate error responses. This enables seamless synchronization of course staff access between Open edX and MITx OnlineScreenshots (if appropriate):
How can this be tested?
Additional Context