Institutional setup guide

Set up MATCHA with LTI Advantage

Connect MATCHA to your learning management system for secure course launches, roster access, activity creation, and grade return. Choose your LMS to see the corresponding administrator workflow.

Before you begin

You need LMS administrator permissions and administrator access to your MATCHA organization.
LTI must be enabled for the organization. If the LTI section is unavailable, contact MATCHA Support.
MATCHA uses LTI 1.3 with Assignment and Grade Services (AGS), Names and Role Provisioning Services (NRPS), and Deep Linking.
Use only public registration values. Never paste an LMS password, private key, developer secret, API token, or application secret into MATCHA.

Which LMS are you setting up?

Select a platform to show its registration and deployment steps.

Learning management system

Canvas

Canvas setup

Create an LTI developer key from MATCHA's JSON configuration, install it by client ID, and enable the course-navigation placement.

In the root Canvas account, open Admin → Developer Keys, choose + Developer Key → + LTI Key, and set the configuration method to Paste JSON.
Paste the MATCHA configuration JSON shown below, save the LTI key, and turn the key on.
Copy the numeric client ID. Then open Admin → Settings → Apps → View App Configurations, choose + App, select By Client ID, enter the client ID, and install the app.
Open the installed app settings and copy its deployment ID.
In the MATCHA Dashboard, open the organization LTI settings, select Canvas, and enter the Canvas instance URL, environment, client ID, and deployment ID.
In each intended course, open Settings → Navigation, enable MATCHA, save the navigation order, and test an instructor launch from the MATCHA course link.

Canvas configuration JSON

Use Paste JSON when configuring the Canvas LTI developer key.

{
  "title": "MATCHA",
  "description": "MATCHA LTI integration",
  "oidc_initiation_url": "https://dash.matchawriter.com/api/lti/login",
  "target_link_uri": "https://dash.matchawriter.com/api/lti/launch",
  "redirect_uris": [
    "https://dash.matchawriter.com/api/lti/launch"
  ],
  "public_jwk_url": "https://dash.matchawriter.com/api/lti/jwks",
  "custom_fields": {
    "matcha_course_end_at": "$Canvas.course.endAt",
    "matcha_term_end_at": "$Canvas.term.endAt",
    "matcha_term_name": "$Canvas.term.name",
    "matcha_term_id": "$Canvas.term.id"
  },
  "scopes": [
    "https://purl.imsglobal.org/spec/lti-ags/scope/lineitem",
    "https://purl.imsglobal.org/spec/lti-ags/scope/lineitem.readonly",
    "https://purl.imsglobal.org/spec/lti-ags/scope/result.readonly",
    "https://purl.imsglobal.org/spec/lti-ags/scope/score",
    "https://purl.imsglobal.org/spec/lti-nrps/scope/contextmembership.readonly"
  ],
  "extensions": [
    {
      "domain": "dash.matchawriter.com",
      "tool_id": "matcha-activities",
      "platform": "canvas.instructure.com",
      "privacy_level": "public",
      "settings": {
        "text": "MATCHA",
        "icon_url": "https://dash.matchawriter.com/matcha-lti-icon.png",
        "placements": [
          {
            "placement": "course_navigation",
            "message_type": "LtiResourceLinkRequest",
            "target_link_uri": "https://dash.matchawriter.com/api/lti/launch?matcha_destination=course_landing",
            "text": "MATCHA",
            "icon_url": "https://dash.matchawriter.com/matcha-lti-icon.png",
            "enabled": true
          },
          {
            "placement": "assignment_selection",
            "message_type": "LtiDeepLinkingRequest",
            "target_link_uri": "https://dash.matchawriter.com/api/lti/deep-link",
            "text": "MATCHA activity",
            "icon_url": "https://dash.matchawriter.com/matcha-lti-icon.png"
          }
        ]
      }
    }
  ]
}

LMS interface labels can vary by release and institutional theme. Read Canvas's LTI administrator documentation .

Blackboard Learn

Blackboard Learn setup

Register MATCHA as an LTI 1.3/Advantage tool, approve the required services, synchronize its course placement, and record the deployment.

Obtain the MATCHA Anthology application ID (client ID) from MATCHA Support. Blackboard requires the tool application to exist in the Anthology Developer Portal before a Learn site can deploy it.
In the Learn Administrator Panel, open LTI Tool Providers, choose Register LTI 1.3/Advantage Tool, and enter the MATCHA application ID.
Approve the tool for the intended courses. Allow role, name, and email sharing, Grade Service access, and Membership Service access according to your institution's policy.
Open the MATCHA provider's Manage Placements page and synchronize placements. Confirm that MATCHA Activities is available as the course placement.
Copy the deployment ID created by Learn. Also retain Blackboard's public issuer, OIDC authorization URL, public keyset URL, and OAuth token endpoint.
In the MATCHA Dashboard, open the organization LTI settings, select Blackboard, and enter the application ID, deployment ID, and the public Blackboard registration values. Never enter the application secret or an API token.
In an Ultra course, open Books & Tools → Browse all course tools, add MATCHA Activities from Institution Tools, make it visible to students when ready, and test an instructor launch.

Blackboard tool values

These public values describe MATCHA's tool application. Ask MATCHA Support for the Anthology application ID used by your deployment.

Application name: MATCHA
Supports LTI 1.3: On
Domain: dash.matchawriter.com
OIDC login initiation URL: https://dash.matchawriter.com/api/lti/login
Tool redirect URI: https://dash.matchawriter.com/api/lti/launch
Tool JWKS: https://dash.matchawriter.com/api/lti/jwks
Signing algorithm: RS256
Course placement target link URI: https://dash.matchawriter.com/api/lti/launch?matcha_destination=course_landing

LMS interface labels can vary by release and institutional theme. Read Blackboard Learn's LTI administrator documentation .

Brightspace

Brightspace setup

Create a Standard LTI Advantage registration, deploy it to the intended org units, and add a basic course link.

Register the tool: in Brightspace, open Admin Tools → Manage Extensibility, select the LTI Advantage tab, choose Register Tool, then select Standard.
Enter every MATCHA tool value below and add both redirect URLs. Enter the Keyset URL before selecting extensions; Brightspace disables the extension checkboxes until a Keyset URL is present.
Enable Assignment and Grade Services and Names and Role Provisioning Services, and select Send Institution Role. Deep Linking is enabled by default in current Brightspace releases. Then choose Register.
From the completed registration, save the generated Client ID, Issuer, OpenID Connect Authentication Endpoint, and Brightspace Keyset URL.
Deploy the tool: open Admin Tools → External Learning Tools → LTI Advantage. On the LTI Advantage Deployments page, choose New Deployment and select the registered MATCHA tool.
Enable Assignment and Grade Services and Names and Role Provisioning Services again for the deployment. Under Security Settings, select every option in User Information and keep Org Unit Information and Link Information enabled.
Under Configuration Settings, leave Auto Create Grade Items cleared because MATCHA creates and associates its own grade items through Assignment and Grade Services. Select Grades created by LTI will be included in the Final Grade if MATCHA grades should count automatically.
Use Add Org Units to share the deployment with the intended courses, then choose Create Deployment.
Copy the generated Deployment ID, then enter it and the registration values from step 4 in the MATCHA organization LTI settings.
Create the course link: open the MATCHA deployment in Brightspace, scroll to the bottom, choose View Links → New Link, set the name to MATCHA Activities, paste the Target Link URL shown below, select Basic Launch as the type, then choose Save and Close.
Add MATCHA to a course: open the course and select a Content module. In the New Content Experience, choose Add Existing → External Tool Activity → MATCHA Activities. In Classic Content, choose Existing Activities → External Learning Tools → MATCHA Activities. Make the item visible to students when it is ready.

Brightspace Standard registration values

Enter both redirect URLs and the values below in the Standard registration form.

Name: MATCHA
Domain: https://dash.matchawriter.com
Redirect URL 1: https://dash.matchawriter.com/api/lti/launch
Redirect URL 2: https://dash.matchawriter.com/api/lti/deep-link
OpenID Connect Login URL: https://dash.matchawriter.com/api/lti/login
Target Link URI: https://dash.matchawriter.com/api/lti/launch?matcha_destination=course_landing
Keyset URL: https://dash.matchawriter.com/api/lti/jwks
Brightspace OAuth2 Access Token URL: https://auth.brightspace.com/core/connect/token
Brightspace OAuth2 audience: https://api.brightspace.com/auth/token

LMS interface labels can vary by release and institutional theme. Read Brightspace's LTI administrator documentation .

Public registration reference

MATCHA LTI endpoints

These tool-owned endpoints are public and may be shared with your LMS administrator. They are generated from the same registration source used in the MATCHA Dashboard.

OpenID Connect login initiation URL: https://dash.matchawriter.com/api/lti/login
Launch and redirect URI: https://dash.matchawriter.com/api/lti/launch
Public keyset (JWKS) URL: https://dash.matchawriter.com/api/lti/jwks
Course landing target link URI: https://dash.matchawriter.com/api/lti/launch?matcha_destination=course_landing
Deep Linking target URI: https://dash.matchawriter.com/api/lti/deep-link

Global LTI host: https://dash.matchawriter.com

Complete the connection in MATCHA

Open the MATCHA Dashboard, select the organization, and open its LTI settings.
Select Canvas and enter the public values produced by your LMS.
Register the installation, then launch MATCHA from a test course as an instructor.
Confirm that the correct course opens before making the LMS link visible to students.

A client ID and deployment ID identify one LMS installation. Do not reuse a deployment ID from a different LMS environment or institution.