As an admin, you can enable the Engage learning management system (LMS) API integration for Moodle, which syncs Moodle courses and users to Engage. Once you integrate the Engage API into Moodle, you can use Engage features within your Moodle course.
Installing the Engage Moodle Plugin
Before you integrate Engage into Moodle, you must first install the Engage Moodle plugin.
- Log in to Engage as an admin.
- In the sidebar, select Integrations.
- From the Choose Integration Type drop-down menu, select LMS - API.
- From the Choose LMS drop-down menu, select Moodle.
- In the Moodle Plugin section, click Download Plugin. The plugin will download to your device as a ZIP file.
- Log in to Moodle as an admin and select the Site administration tab.
- Select the Plugins tab.
- Select Install plugins.
- Click Choose a file... and then upload the ZIP file downloaded in step 5.
- Click Install plugin from the ZIP file.
- Click Continue.
- Click Continue.
- Click Upgrade Moodle database now.
Creating and Configuring the Moodle Access Token
Before integrating Engage into Moodle, you must create an access token to communicate between Moodle and Engage.
- Log in to Moodle as an admin and select the Site administration tab.
- Select the Server tab.
- Select Manage tokens.
- Click Create token.
- Select a User that you want the token to be associated with.
- In the Service drop-down menu, select Moodle mobile web service.
- Click Save changes.
- Click Copy to clipboard to copy the newly created token. It will be required for step 5 of Integrating Engage into Moodle.
- Navigate back to Site administration.
- Select the Server tab.
- Select External services.
- In the External Services section, locate Moodle mobile web service and select its Functions.
- Click Add functions.
- From the Name drop-down menu, select the functions below:
- core_course_get_courses
- core_enrol_get_enrolled_users
- local_engageapi_list_sections
- local_engageapi_create_section
- local_engageapi_create_lti
- local_engageapi_get_cmid_from_gradeitem
- local_engageapi_update_lti_grade
- Click Add functions to save the changes.
Integrating Engage into Moodle
Once the access token has been created, you can add your Moodle API link and access token to allow Engage to connect with your Moodle environment.
- Log in to Engage as an admin.
- In the sidebar, select Integrations.
- From the Choose Integration Type drop-down menu, select LMS - API.
- From the Choose LMS drop-down menu, select Moodle.
-
In the API Access section, enter the information as shown below.
-
LMS API Link: https://<Your_Engage_Domain_URL>/webservice/rest/server.php
- Example: https://evergreen.engage.yuja.com/webservice/rest/server.php
- Access Token: Click Override to enter the token copied in step 8 of Creating and Configuring the Moodle Access Token.
-
LMS API Link: https://<Your_Engage_Domain_URL>/webservice/rest/server.php
-
Adjust any additional Linkage Settings:
- Moodle Course: Select Moodle Course ID.
- Moodle Users: Select Moodle User ID or Primary Email.
- Use Email as Backup Field: Enable the Use Email as Backup Field toggle.
- Click Save Changes.