Quick start: Brightspace Connector

Connect your sub-account to D2L Brightspace, then enroll students, remove access and award badges from your workflows. Plan on about 15 minutes, plus five minutes from your Brightspace admin. Not installed yet? The app is in private beta: request access and we will send you the install link.

Part 1: for you

1Install the app

Install Brightspace Connector from the GHL Marketplace into the sub-account that sells your courses. Once it's installed, open it from that sub-account to reach the setup page.

Install into a sub-account. The app connects one sub-account to one Brightspace site. If you run several sub-accounts, install it in each one that needs Brightspace.

2Ask your Brightspace admin to register it

Brightspace Connector signs in to Brightspace with Brightspace's own server-to-server method. Your Brightspace admin registers the app on their side, and you never handle a password or secret key.

Send your admin this link

Part 2 of this guide has everything they need, step by step: Register Brightspace Connector in Brightspace. Copy this page's address, add #bsc-admin to the end, and send it to them.

Send them the JWKS URL and Scope too. Copy both from Steps for your Brightspace admin on the setup page; they're specific to your sub-account. Set the two options at the top of that section first (creating users, awarding badges), because they change the Scope.

They'll send you back two things: your Brightspace site address and the app's Client ID.

The setup page shows the same registration steps, with copy buttons, if your admin is sitting with you.

3Connect Brightspace

On the setup page, fill in Connect Brightspace:

FieldExampleNotes
Brightspace site URLhttps://yourschool.brightspace.comThe address you use to sign in to Brightspace. Just the start of it is enough.
Client IDa3f1c9e2-58d4-4b7a-9c1e-…From your admin. Treat it like a key: don't post it anywhere public.

Click Test & save connection. The app signs in to your Brightspace right away. When it works, you'll see Connected to yourschool.brightspace.com. If it doesn't, the message says what to fix. See Troubleshooting.

4Choose the student role

Under Student role, choose the Brightspace role your students have. It's usually called Learner or Student, and the app picks it for you when it can. Click Save role.

New students are enrolled with this role, and the student import only brings in users who have it.

5Add the actions to your workflows

In any workflow, click + to add an action and search for Brightspace. Email, first name and last name are filled in from the contact for you. For Course, choose from the list, which comes live from your Brightspace.

The Enroll Student action in a workflow, with the course chosen from a list
ActionWhat it doesFields
Enroll Student in BrightspaceFinds the student by email, creates their account if needed, and enrolls them in the course.Email, first and last name, Course, Send Brightspace welcome email
Create Brightspace UserCreates the account without enrolling them anywhere.Email, first and last name, optional username (defaults to the email) and Org Defined ID, Send Brightspace welcome email
Unenroll Student from BrightspaceRemoves the student from the course. Their account stays.Email, Course
Award Brightspace BadgeIssues a badge or certificate to the student in that course.Email, Course, Award ID, optional comment
The welcome email: when it's on, Brightspace emails new students their login details. Turn it off if you'd rather send your own welcome from GoHighLevel.
Finding an Award ID: Brightspace doesn't show award ID numbers on screen, so ask your Brightspace admin for the ID of each badge or certificate you want to issue. The award must be available in the course you choose. Part 2 explains how they find it.

Recipes

Enroll on purchase

Trigger: the payment or order trigger for your course product. Action: Enroll Student in Brightspace with that course.

Remove access on refund

Trigger: your refund or cancellation event, or a tag such as refunded. Action: Unenroll Student from Brightspace with the same course.

Badge at a milestone

Trigger: a tag such as passed-practical added by your team. Action: Award Brightspace Badge with the course and the award's ID.

6Import your existing students (optional)

Already have students in Brightspace? Sync Brightspace students adds them as contacts, matched by email so nobody is duplicated. Run it again any time to pick up new students. The import is included with the paid plan.

  1. Optionally tick Create a tag for each course to tag each student with the courses they're enrolled in.
  2. Tick the box confirming you understand these contacts haven't opted in to marketing.
  3. Click Sync Brightspace students and watch the progress bar. You can leave the page while it runs.
Pause messaging workflows first. Workflows triggered by Contact Created or Contact Tag will run for every imported student. Pause any that send emails or texts before you import. Every imported contact is tagged brightspace-import so you can find them later.

7Troubleshooting

What you seeWhat to do
"Brightspace didn't accept this Client ID…"Check the Client ID was copied exactly. Then ask your admin to confirm the app uses Client Credentials, its JWKS URL matches the one on your setup page, and a Service User is linked to it.
"The Brightspace app registration is missing some of the required scopes…"Your admin needs to paste the full Scope line from your setup page into the app's Scope field. If you changed an option after they registered, send them the new line.
"Signed in to Brightspace, but … rejected the request"The site URL doesn't match the Brightspace where the app was registered. Check the address with your admin.
"Enter the full Brightspace site URL…"Include the https:// part, for example https://yourschool.brightspace.com.
"Couldn't load roles", or no courses in the Course listThe Service User's role can't see roles or courses. Ask your admin to check its permissions against Part 2.
"Brightspace is not connected for this location. Finish setup first."A workflow ran before setup was finished. Complete steps 3 and 4.
"No student role selected for this Brightspace connection"Choose and save a role in step 4.
"No Brightspace user found for name@example.com"Unenroll and Award Badge need an existing Brightspace account with that email. Check the contact's email matches their Brightspace account.
"Student sync is available on the paid plan."Upgrade from the app's Marketplace listing to unlock the import.
Part 2: for your Brightspace admin

Register Brightspace Connector in Brightspace

Someone in your organization uses Brightspace Connector to enroll students in Brightspace automatically from their CRM. This part walks you through allowing it. It takes about five minutes.

How it signs in: Brightspace Connector uses OAuth 2.0 Client Credentials with a Private Key JWT. Brightspace checks each sign-in against our public key, so there is no client secret, and you never share a Brightspace password. The app acts only as the Service User you create below, with only the permissions you give that user. To revoke access, delete the app registration.

Before you start

Your own role needs Service Users > See Service Users Tool and Manage Extensibility > Can Manage API Applications.

Step 1: Create a Service User

In Admin Tools → Manage Extensibility, open Service Users and create a Service User just for this integration, for example Brightspace Connector. Give it a role that can do the following, and nothing more:

  • Users: look up users and see their email address (in User Information Privacy; the app needs no other user fields). Creating users too, unless your contact has turned that option off.
  • Enrollments: see, create and remove enrollments in course offerings.
  • Roles: see and manage your student role (for example Learner), so students can be enrolled with it.
  • Awards (only if badges or certificates will be issued): See Badges and Issue Badges, or See Certificates and Issue Certificates.

Then enroll the Service User, with a role that cascades, in the part of your org structure the app should work in, for example a single department, or in each course. The app only sees, and enrolls students into, courses the Service User is enrolled in. It never creates or deletes courses or other org units.

Step 2: Register the app

In Admin Tools → Manage Extensibility, open the OAuth 2.0 tab and click Register an app. Enter:

FieldValue
Grant TypeClient Credentials
Application NameBrightspace Connector
JWKS URLThe URL your contact sent you, from their setup page. It looks like https://brightspace.ciba.app/jwks/… and is unique to their sub-account. If they connect several sub-accounts, register a separate app for each.
ScopeThe exact Scope line your contact sent you, from the same setup page. It depends on the options they chose; it only includes core:*:* if they'll award badges.
Access Token Lifetime (seconds)3600
Service UserClick Add Service User and choose the one from step 1.

Add a description, accept the API Developer Agreement, and click Register.

Step 3: Send back two things

Send these only to the person setting up the app. Treat the Client ID like a key: anyone who has it could connect the app to your Brightspace, so don't post it anywhere public.

  1. The new app's Client ID, shown in the OAuth 2.0 applications list.
  2. Your Brightspace site address, for example https://yourschool.brightspace.com.

Award IDs (only if badges or certificates will be issued)

The Award Badge action needs each award's numeric ID, which Brightspace doesn't show on screen. You can list awards and their AwardId values through the Brightspace API, using GET /d2l/api/bas/(version)/awards/ (version 1.4 or later). It accepts a search parameter that matches award titles. Skip awards marked IsDeleted, and send the IDs of the ones you want issued.

Questions about setup? Email aaron@canitbeautomated.com.
Brightspace Connector is a CanItBeAutomated product. Brightspace and D2L are trademarks of D2L Corporation. Not affiliated with or endorsed by D2L Corporation or HighLevel Inc.