> ## Documentation Index
> Fetch the complete documentation index at: https://docs.puddin.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Connect Puddin to Brightspace (D2L) via LTI 1.3 Setup

> Register Puddin as an LTI Advantage tool in Brightspace (D2L), configure deployment settings, and roll it out across your org units.

Integrating Puddin with Brightspace (D2L) allows students to launch Puddin writing sessions directly from their Brightspace courses using their existing credentials. Brightspace manages LTI 1.3 tools through its External Learning Tools framework, which supports LTI Advantage — the full suite of LTI 1.3 services including Names and Roles Provisioning and Assignment and Grade Services for gradebook passback.

## Prerequisites

Before you begin, confirm that you have the following:

* Brightspace administrator access at the organisation level
* Access to the Puddin administrator panel (Settings → Integrations)
* Puddin's LTI 1.3 configuration values ready to copy (see [LTI Setup overview](/core/integrations/lti-setup))

## Setup steps

<Steps>
  <Step title="Open the Puddin Integrations panel">
    Sign in to Puddin as an administrator. Navigate to **Settings → Integrations** and locate the **Brightspace / LTI 1.3** section. Keep this tab open — you will copy values from it into Brightspace throughout the following steps.

    Note down the following values:

    * Tool URL
    * Client ID
    * Public Keyset URL
    * Access Token URL
    * Authentication Request URL (OIDC endpoint)
  </Step>

  <Step title="Navigate to External Learning Tools">
    Sign in to Brightspace as an organisation-level administrator. From the top navigation bar, open the **Admin Tools** menu (the gear icon) and select **External Learning Tools**.

    The External Learning Tools screen lists all currently registered tools and deployments.
  </Step>

  <Step title="Register Puddin as an LTI Advantage tool">
    Click **New Tool** (or **Register Tool**, depending on your Brightspace version). Select **Standard** registration mode.

    Fill in the registration form using the values from the Puddin Integrations panel:

    | Brightspace field         | Puddin value to paste                                   |
    | ------------------------- | ------------------------------------------------------- |
    | Name                      | Puddin (or your preferred display name)                 |
    | Description               | Optional — a short note for administrators              |
    | Domain                    | Your Puddin instance domain (e.g. `youruni.puddin.app`) |
    | Client ID                 | Client ID                                               |
    | Keyset URL                | Public Keyset URL                                       |
    | Access Token URL          | Access Token URL                                        |
    | OIDC Login Initiation URL | Authentication Request URL                              |

    <Note>
      Brightspace uses the **Domain** field to validate that launch requests originate from the registered tool. Enter only the domain portion of your Puddin URL — do not include the path or trailing slash.
    </Note>
  </Step>

  <Step title="Enable LTI Advantage services">
    In the **Extensions** or **Services** section of the registration form, enable the following:

    * **Names and Role Provisioning Services** — allows Puddin to retrieve course membership information
    * **Assignment and Grade Services** — enables grade passback to the Brightspace gradebook
    * **Deep Linking** — allows Puddin links to be embedded directly in course content

    Click **Save** to complete the tool registration.
  </Step>

  <Step title="Copy Brightspace platform values to Puddin">
    After saving, Brightspace displays platform registration details including a **Deployment ID** and platform identifier. Copy these values into the corresponding fields in the Puddin Integrations panel and click **Save** in Puddin to finalise the two-way configuration.
  </Step>

  <Step title="Create a deployment for your org units">
    Registered tools in Brightspace must be deployed to org units before instructors and students can use them.

    From the External Learning Tools screen, find the Puddin tool registration and click **New Deployment** (or **View Deployments → Add Deployment**).

    Configure the deployment:

    * **Tool:** Select Puddin
    * **Name:** Give the deployment a name (for example, `Puddin – All Courses`)
    * **Extensions:** Confirm that Assignment and Grade Services is enabled
    * **Org Units:** Select the org units where Puddin should be available. To deploy across the entire organisation, select the root org unit and enable **cascade to child org units**

    Click **Create Deployment**.

    <Tip>
      If you want to pilot Puddin with a single faculty or department first, scope the deployment to that org unit's subtree. You can expand it later without re-registering the tool.
    </Tip>
  </Step>

  <Step title="Add Puddin as a course activity link">
    Once deployed, instructors can add Puddin to their courses by inserting an **External Learning Tool** activity in any content area. They select Puddin from the tool list and configure the link details.

    For a consistent student experience, consider providing instructors with a short guide explaining how to create a Puddin assignment activity in their course.
  </Step>

  <Step title="Test the connection">
    Open a test course in Brightspace and add Puddin as an external learning tool activity. Access it as a student (use Brightspace's **Preview as Student** option) and confirm that:

    * The Puddin session launches without a separate login prompt
    * The correct course and assignment context is displayed in Puddin
    * The test submission appears in the Puddin teacher dashboard
    * If grade passback is configured, a grade appears in the Brightspace gradebook after submission
  </Step>
</Steps>

## Troubleshooting

If students see a "Tool launch failed" error, verify that the OIDC Login Initiation URL in Brightspace exactly matches the Authentication Request URL in the Puddin Integrations panel.

If grade passback is not writing to the gradebook, confirm that the deployment has **Assignment and Grade Services** enabled (Step 6) and that the course activity is set up as a graded item in Brightspace.

For additional troubleshooting steps, see the [Troubleshooting guide](/core/troubleshooting).
