openedx-events-2-n8n 0.5.0

Django Signal Handlers

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):
    n8n_payload = {
        "user": asdict(user),
        "event_metadata": asdict(metadata),
    }
    requests.post(
        settings.N8N_REGISTRATION_WEBHOOK,
        json=flatten_dict(n8n_payload),
        timeout=N8N_REQUEST_TIMEOUT,
    )

• The receiver decorator listens to the STUDENT_REGISTRATION_COMPLETED signal.

• The handler function send_user_data_to_webhook extracts the user and metadata from the signal.

• The N8N_REGISTRATION_WEBHOOK URL is configured as a Django settings by using a Tutor plugin.

• The extracted data is formatted into a payload and sent to the n8n webhook for further processing.

App Configuration (apps.py)

The Django app is configured using an AppConfig to automatically register handlers on startup.

class OpenedxEvents2N8nConfig(AppConfig):
    name = "openedx_events_2_n8n"

    def ready(self):
        from openedx_events_2_n8n import handlers

Testing Each Auth Type

Set the n8n Webhook node’s credential to match, save a WebhookConfig with the same values, then trigger the event (e.g. enroll a user). Check /admin/openedx_events_2_n8n/webhookevent/ for the delivery result (status code, response body, error).

None

• WebhookConfig: auth_type=none.

• n8n Webhook node: credential set to None.

• Verify directly with curl:

curl -X POST https://<your-n8n-domain>/webhook/<path> -H "Content-Type: application/json" -d '{"ping": "test"}'

Basic Auth

• WebhookConfig: auth_type=basic, basic_auth_username, basic_auth_password.

• n8n Webhook node: credential type Basic Auth with matching username/password.

• Verify directly with curl:

curl -X POST https://<your-n8n-domain>/webhook/<path> -u "<username>:<password>" -H "Content-Type: application/json" -d '{"ping": "test"}'

Header Auth

• WebhookConfig: auth_type=header, header_auth_name (e.g. X-Api-Key), header_auth_value.

• n8n Webhook node: credential type Header Auth with the same header name/value.

• Verify directly with curl:

curl -X POST https://<your-n8n-domain>/webhook/<path> -H "X-Api-Key: <header_auth_value>" -H "Content-Type: application/json" -d '{"ping": "test"}'

JWT Auth

• WebhookConfig: auth_type=jwt, jwt_auth_secret (HS256 passphrase).

• n8n Webhook node: credential type JWT Auth, algorithm HS256, same secret.

• The plugin signs a short-lived token itself (60s TTL) and sends it as Authorization: Bearer <token>; to verify manually, mint a token with the same secret:

python -c "import jwt,time; print(jwt.encode({'iat': int(time.time()), 'exp': int(time.time())+60}, '<jwt_auth_secret>', algorithm='HS256'))"

curl -X POST https://<your-n8n-domain>/webhook/<path> -H "Authorization: Bearer <token-from-above>" -H "Content-Type: application/json" -d '{"ping": "test"}'

4. Configure n8n webhooks to receive JSON event data, follow the instructions available in the n8n documentation.

5. 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.