Admins and IT managers can enable the Engage LMS API integration for Moodle, which enables the synchronization of courses and users with the Engage Platform. This integration allows IT Managers to make adjustments for individual users and Creators to activate Polls within their courses for gradebook sync. Please follow the steps below to learn how to enable the LMS API integration.
Creating and Configuring the Moodle Access Token
Before setting up the integration with Engage, an access token must be created to communicate between Moodle and Engage.
- Log in to Moodle and click Site administration.
- Select the Plugins tab.
- Select Manage tokens.
- Click Add.
- Select a user the token will be associated with.
- For Service, select MOODLE API.
- Click Save changes.
- Copy the newly created token, it will be required for the next section of this guide.
- Next, navigate back to Site administration.
- Select the Plugins tab.
- Select External Services.
- Under External Service, locate the MOODLE API and select the option for its Functions.
- Click Add functions.
- Use the drop-down menu to add the functions listed below.
- core_course_get_courses
- core_enrol_get_enrolled_users
- Click Add functions to complete the process.
Integrating Moodle with Engage
Once the access token has been created, it can be added to your Engage instance to integrate Moodle with Engage.
- Log in to Engage as an IT Manager.
- Select Integrations from the left-side navigation menu.
- From the Choose Integration Type drop-down menu, select LMS - API and select Moodle.
- Under API Access, fill out the information as shown below.
-
Domain: Your Moodle domain URL.
- Example: evergreen.moodle.com
-
LMS API Link: https://<Your_Engage_Domain_URL>/webservice/rest/server.php
- Example: https://evergreen.engage.yuja.com/webservice/rest/server.php
- Access Token: Enter the token copied in the previous section of this guide.
-
Domain: Your Moodle domain URL.
- Adjust any additional Linkage Settings.
- Moodle Course: The primary linkage attribute will be based on the Moodle Course ID.
- Moodle Users: The primary linkage attribute can either be the user's Moodle User ID or their Primary Email.
-
It is recommended that you check: Use user email and user's name as backup fields if no Moodle User ID is found
- Click Save Changes to complete the process.