DEEP_LINKING_RESPONSE

Sent when a teacher finishes picking content in a tool's deep linking picker. Store the selection against the course, then close the picker.

caution

This one request arrives form-urlencoded, not as JSON — it is delivered by a self-submitting form in the user's browser rather than a server-to-server call. Every other service request uses a JSON body.

Because the browser is sitting on this response, a good pattern is to return a small HTML page that posts a message to the parent window and lets it close the iframe. See the deep linking guide for a worked example.

Only ltiResourceLink items are ever present — LTIAAS rejects other types before they reach you.

The decoded payload:

{
  "type": "DEEP_LINKING_RESPONSE",
  "parameters": {
    "context": "2022CSEa5e6c431b91",
    "clientId": "qR8E0iHqSdR30DdfQAbcaBGjKT65",
    "contentItems": [
      {
        "type": "ltiResourceLink",
        "url": "https://mytool.com/lti/launch?resource=13",
        "title": "Resource 13"
      }
    ]
  }
}

application/x-www-form-urlencoded

Request Body required

payload string required

An RS256 JWT signed by LTIAAS, valid for ten minutes.

Responses

Any body you like — an empty response is fine, but returning HTML lets you close the picker cleanly.

text/html

Schema

Schema

string

DEEP_LINKING_RESPONSE​

DEEP_LINKING_RESPONSE