Bracken Compatibility API

Home | API reference

Configuring LTI Gradebook

To configure an LTI platform such as Moodle to receive Gradebook responses from Bracken, follow these steps.

Platform (Moodle)

Configure Bracken as a tool.

Property Sample value Description
Tool URL https://demo.bracken.cloud
LTI Version LTI 1.3
Client ID 0EH2m8WZjDiAQuf This value is generated by the platform.
Public key type Keyset URL
Public keyset https://compat-api.bracken.cloud/jwks The JWKS endpoint on this server.
Initiate login URL https://demo.bracken.cloud/auth/lti Login to portal; clears the portal cookie before logging in.
Redirect URLs https://identity.brackenlearning.com/signin-moodlecontainerwork The signin URL is the scheme with non-alpha characters removed.
Launch container New window Identity Server cookies only work in new window.
Services
Assignment and Grade Service Use this service for grade sync only
Privacy
Share launcher's name Always
Share launcher's email Always

Bracken

External provider

Configure an external provider in Bracken:

Property Sample value Description
Scheme http://moodle.container.work
Client ID 0EH2m8WZjDiAQuf Client ID provided by Moodle.
Client secret - Client secret not used
Authority http://moodle.container.work/mod/lti/openid-configuration.php OpenID configuration. If discovery document is not available, configure OAuth2 URLs manually.

Identity Server

Configure in IdentityServer appsettings.json and restart the service.

"ExternalProviders": [{
    "Scheme": "http://moodle.container.work",
    "Handler": "Lti"
}]

Compatibility API

Add the secret to the runtime variables or .env file and restart the service.

DOMAIN_CREDENTIALS='{ "14354": { "clientId": "demo", "clientSecret": "<client_secret>" } }'

Webhook

Configure the module completion webhook using Postman or cURL. See webhook reference for information about the lti-ags transform.

PUT {{api_host}}/api/webhook/merge/event/Module_Complete
Authorization: Bearer eyJH...
Content-Type: application/json
{
    "target": "https://compat-api.bracken.cloud/webhook/lti-ags?target=http%3a%2f%2fmoodle.container.work",
    "secret": "<client_secret>",
    "active": true
}

Creating gradebook activity

In Moodle, create a new External Tool activity.

Property Sample value Description
Tool URL https://demo.bracken.cloud/e/lesson/66 External lesson viewer.
Grade
Type Point
Maximum grade 100 This can be different to the points in the module.