This document has nothing to do with Edlink's support for LTI (Learning Tools Interoperability) 1.1 or 1.3 integrations. It is purely about the External Tool attachment type.
For more information on how your application can support LTI 1.1 or 1.3 integrations, please see our associated developer guide
An External Tool is a type of Attachment that represents an LTI (Learning Tools Interoperability) external tool. External Tool attachments can be associated with Assignments, Announcements, or Pages.
External Tool attachments are always part of an attachments object within a larger entity (like an assignment or page). There are no direct endpoints to list all external tools from a class or other entity independently.
Properties
| Property | Type | Description |
|---|---|---|
type | AttachmentType | The type of the attachment, always lti. |
title | string | The title of the external tool. |
description | string | A description of the external tool. |
url | string | The launch URL for the external tool. |
parameters | object | Optional custom parameters to be sent with the LTI launch. This can be any arbitrary JSON object. |
JSON Example
{
"type": "lti",
"title": "Interactive Math Game",
"description": "A fun game to practice algebra skills.",
"url": "https://example.com/lti/math-game",
"parameters": {
"resource_id": "math-game-101",
"difficulty": "medium"
}
}