Moodle installation

How to connect your Moodle site to Coassemble with the Coassemble plugin, from creating your API key through to adding your first Coassemble activity.

How do I connect Moodle to Coassemble?

Create an API key in Coassemble, install the Coassemble plugin on your Moodle site, enter your key and run the connection test, then choose which builder features to offer. Once that’s done, your teachers can add Coassemble activities to their courses.

Before you start

1. Create a Coassemble API key. In Coassemble, open Developer, then API keys, and click Create key. Copy the whole key straight away, as only a masked version is shown afterwards.
2. Check your site. It needs to be on Moodle 4.1 to 5.3 with PHP 8.1 or later, and served over HTTPS.
3. Turn on completion tracking. Go to Site administration, then Advanced features, and turn on Enable completion tracking.
4. Have the plugin package ready. You’ll need the plugin as a ZIP file.

You’ll need site administrator access in Moodle for every step below.

Step 1: Install the plugin

1. Go to Site administration, then Plugins, then Install plugins, and upload the ZIP file.
2. Follow the prompts and let the upgrade run to completion.

You can also unzip the plugin into a folder called coassemble inside your Moodle mod folder, then go to Site administration, then Notifications to finish the install. When you update the plugin this way, replace the whole folder rather than copying new files over the old ones.

Step 2: Connect it to Coassemble

Go to Site administration, then Plugins, then Activity modules, then Coassemble, and fill in the settings:

Setting	What to enter
API base URL	https://api.coassemble.com. It’s filled in already, so leave it as it is.
API key	Your whole Coassemble API key, starting with COASSEMBLE:

1. Save the key. This also sets up automatic progress updates from Coassemble, which needs your site to be on HTTPS.
2. Click Run connection test. Both checks need to pass. The test also checks your progress updates are set up, and fixes them if needed.
3. Click Save changes.

Step 3: Choose your builder features

On the same settings page, under Course builder features, choose what teachers can use. Every feature is switched on to start with, so switch off anything you don’t want to offer:

Feature	What it does
AI generation	Lets teachers generate a course with AI, and use AI in the builder.
Google Drive import	Lets teachers bring in content from Google Drive.
OneDrive import	Lets teachers bring in content from OneDrive.
Narrations	Adds voice narration to courses. Narration comes from your workspace’s shared allowance.
Translations	Lets teachers translate courses into other languages.
Brand voice	Keeps AI-written content in your organisation’s tone.

Step 4: Add your first Coassemble activity

1. As an editing teacher, add a Coassemble activity to a course.
2. Give it a name, choose how to start (Start from scratch, Generate with AI or Use an existing course), then click Save and display.
3. Build your course. If you chose an existing course, pick Use this course to share the original, or Make a copy to get a separate version for this activity.
4. Publish the course from inside the builder.
5. Open Manage content to check the course is linked and published.
6. Log in as a student and complete the course, then check the gradebook and activity completion as the teacher.

Teachers can also browse your workspace’s courses before adding an activity, from More, then Coassemble course library in the course menu.

How do I control who can do what?

The plugin adds four Moodle permissions. Editing teachers and managers have all four by default, and students can view activities. Change them with Moodle roles to suit your site:

Permission	What it allows
mod/coassemble:addinstance	Add a Coassemble activity to a course.
mod/coassemble:author	Open the course builder.
mod/coassemble:manage	Publish, copy, download as SCORM, see the progress report and refresh progress.
mod/coassemble:view	Open the activity and take the course.

Frequently asked questions

Why won’t the connection test pass?

Check you pasted the whole API key, starting with COASSEMBLE:, and that the key hasn’t been deleted or replaced in Coassemble. Then run the test again.

Why is the builder or course showing a blank space?

Your site’s security settings may be stopping Coassemble from loading in a frame. Check your site allows Coassemble to load, and that everything is on HTTPS. If it’s still blank, contact us so we can check your site’s address.

Why aren’t grades or completion updating?

Make sure completion tracking is on and the learner has finished the course. Then open Manage content and click Refresh learner progress. If it keeps happening, check your site is on HTTPS and run the connection test again.

Why can’t I select some courses in the library?

Some types of course can’t be opened through the plugin. They still show in the library, with the reason they’re unavailable.

The builder says my session has expired. What do I do?

Reload the activity to start a new session. Sessions end after a few hours, so publish or save your work before leaving the builder open.

What if I still need help?

Contact your Coassemble contact or reach us through Get help, then Ask us in Coassemble. Include your Moodle, PHP and plugin versions, and what you were doing when it happened. Never include your API key.