edx-platform configuration

• Add the following configuration values to the config file in Open edX. For any release after Juniper, that config file is /edx/etc/lms.yml and /edx/etc/cms.yml. If you’re using private.py, add these values to lms/envs/private.py and cms/envs/private.py. These should be added to the top level.

  ENROLLMENT_WEBHOOK_URL: "https://example.com/api/openedx_webhook/enrollment/"
  ENROLLMENT_WEBHOOK_ACCESS_TOKEN: "<your-oauth-access-token>"
  CERTIFICATE_WEBHOOK_URL: "https://example.com/api/openedx_webhook/certificate/"
  CERTIFICATE_WEBHOOK_ACCESS_TOKEN: "<your-oauth-access-token>"

• Optionally, override the roles that trigger the webhook (defaults to ["instructor", "staff"]):

  ENROLLMENT_COURSE_ACCESS_ROLES: ["instructor", "staff"]

• Set the username of the service worker that the external system uses to create enrollments through the Open edX enrollment REST API. Enrollments created by this user are not sent back to it:

  ENROLLMENT_WEBHOOK_SERVICE_WORKER_USERNAME: "<service-worker-username>"

  This must be the username of the Django user that owns the OAuth2 token the external system authenticates with, because that is the user Open edX resolves the request to. Do not copy the external system’s own service-worker-username setting (for example MITx Online’s OPENEDX_SERVICE_WORKER_USERNAME): nothing keeps the two in sync, and if they disagree the filter never matches and every enrollment the external system creates is sent straight back to it. Resolve the owner from the token itself:

  from oauth2_provider.models import AccessToken
  AccessToken.objects.get(token="<the external system's API token>").user.username

  When the setting is unset, or when the acting user cannot be determined (an enrollment made from a Celery task or a management command), the webhook is dispatched anyway. The receiving endpoint is idempotent, so a redundant call is harmless, while dropping a real enrollment is not.

• For Tutor installations, these values can also be managed through a custom Tutor plugin.