Documentation

ExternalTool extends AbstractBaseApi

in package

• CanvasLMS
• Api
• ExternalTools

Canvas LMS External Tools API

// Account context (default)
$tools = ExternalTool::get();
$tool = ExternalTool::create([
    'name' => 'My LTI Tool',
    'consumer_key' => 'key123',
    'shared_secret' => 'secret456',
    'url' => 'https://tool.example.com/lti/launch',
    'privacy_level' => 'public'
]);

// Course context via Course instance
$course = Course::find(123);
$tools = $course->externalTools();

// Direct context access
$tools = ExternalTool::fetchByContext('courses', 123);
$tool = ExternalTool::createInContext('courses', 123, [
    'name' => 'Course LTI Tool',
    'consumer_key' => 'key456',
    'shared_secret' => 'secret789',
    'url' => 'https://tool.example.com/lti/launch',
    'privacy_level' => 'public'
]);

// Finding and updating tools
$tool = ExternalTool::find(456); // Searches in account context
$tool = ExternalTool::findByContext('courses', 123, 456); // Course-specific

$tool = ExternalTool::update(456, ['name' => 'Updated Tool Name']);

// Using DTOs
$dto = new CreateExternalToolDTO();
$dto->name = 'My Tool';
$dto->consumerKey = 'key123';
$dto->sharedSecret = 'secret456';
$dto->url = 'https://tool.example.com';
$dto->privacyLevel = 'public';
$tool = ExternalTool::create($dto);

// Generate sessionless launch URL
$launchData = ExternalTool::generateSessionlessLaunch(['id' => 456]);

Table of Contents

Properties

$accountNavigation  : array<string, mixed>|null

The configuration for account navigation links

$assignmentSelection  : array<string, mixed>|null

The configuration for assignment selection links

$consumerKey  : string|null

The consumer key used by the tool (shared secret is not returned)

$contextId  : int|null

The context ID for the external tool

$contextType  : string|null

The context type (account, course) for the external tool

$courseHomeSubNavigation  : array<string, mixed>|null

The configuration for course home navigation links

$courseNavigation  : array<string, mixed>|null

The configuration for course navigation links

$createdAt  : string|null

External tool creation timestamp

$customFields  : array<string, string>|null

Custom fields that will be sent to the tool consumer

$deploymentId  : string|null

The unique identifier for the deployment of the tool

$description  : string|null

External tool description

$domain  : string|null

The domain to match links against

$editorButton  : array<string, mixed>|null

The configuration for a WYSIWYG editor button

$homeworkSubmission  : array<string, mixed>|null

The configuration for homework submission selection

$iconUrl  : string|null

The url for the tool icon

$id  : int|null

External tool unique identifier

$isRceFavorite  : bool|null

Boolean determining whether this tool should be in a preferred location in the RCE

$isTopNavFavorite  : bool|null

Boolean determining whether this tool should have a dedicated button in Top Navigation

$linkSelection  : array<string, mixed>|null

The configuration for link selection

$migrationSelection  : array<string, mixed>|null

The configuration for migration selection

$name  : string|null

External tool name

$notSelectable  : bool|null

Whether the tool is not selectable from assignment and modules

$privacyLevel  : string|null

How much user information to send to the external tool Allowed values: anonymous, name_only, email_only, public

$resourceSelection  : array<string, mixed>|null

The configuration for a resource selector in modules

$selectionHeight  : int|null

The pixel height of the iFrame that the tool will be rendered in

$selectionWidth  : int|null

The pixel width of the iFrame that the tool will be rendered in

$sharedSecret  : string|null

The shared secret with the external tool (only used for creation/updates)

$toolConfiguration  : array<string, mixed>|null

The configuration for a tool configuration link

$unifiedToolId  : string|null

The unique identifier for the tool in LearnPlatform

$updatedAt  : string|null

External tool last update timestamp

$url  : string|null

The URL to match links against

$userNavigation  : array<string, mixed>|null

The configuration for user navigation links

$workflowState  : string|null

The workflow state of the external tool

$apiClient  : HttpClientInterface

$methodAliases  : array<string|int, mixed>

Define method aliases

Methods

__callStatic()  : mixed

Magic method to handle function aliases

__construct()  : mixed

Create a new ExternalTool instance

all()  : array<string|int, static>

Get all external tools.

create()  : self

Create a new external tool in the default account context

createInContext()  : self

Create a new external tool in a specific context

delete()  : self

Delete the external tool

fetchByContext()  : array<string|int, self>

List external tools for a specific context

fetchByContextPaginated()  : PaginatedResponse

Get paginated external tools for a specific context

find()  : self

Find a single external tool by ID in the default account context

findByContext()  : self

Find an external tool by ID in a specific context

generateSessionlessLaunch()  : array<string, mixed>

Generate a sessionless launch URL for an external tool in account context

generateSessionlessLaunchInContext()  : array<string, mixed>

Generate a sessionless launch URL for an external tool in a specific context

get()  : array<string|int, static>

Get first page of external tools.

getAccountNavigation()  : array<string, mixed>|null

Get account navigation configuration

getAssignmentSelection()  : array<string, mixed>|null

Get assignment selection configuration

getConsumerKey()  : string|null

Get consumer key

getContextId()  : int|null

Get context ID

getContextType()  : string|null

Get context type

getCourseHomeSubNavigation()  : array<string, mixed>|null

Get course home sub navigation configuration

getCourseNavigation()  : array<string, mixed>|null

Get course navigation configuration

getCreatedAt()  : string|null

Get created at timestamp

getCustomFields()  : array<string, string>|null

Get custom fields

getDeploymentId()  : string|null

Get deployment ID

getDescription()  : string|null

Get external tool description

getDomain()  : string|null

Get domain

getEditorButton()  : array<string, mixed>|null

Get editor button configuration

getHomeworkSubmission()  : array<string, mixed>|null

Get homework submission configuration

getIconUrl()  : string|null

Get icon URL

getId()  : int|null

Get external tool ID

getIsRceFavorite()  : bool|null

Get RCE favorite status

getIsTopNavFavorite()  : bool|null

Get top navigation favorite status

getLaunchUrl()  : string

Generate launch URL for this external tool

getLinkSelection()  : array<string, mixed>|null

Get link selection configuration

getMigrationSelection()  : array<string, mixed>|null

Get migration selection configuration

getName()  : string|null

Get external tool name

getNotSelectable()  : bool|null

Get not selectable status

getPrivacyLevel()  : string|null

Get privacy level

getResourceSelection()  : array<string, mixed>|null

Get resource selection configuration

getSelectionHeight()  : int|null

Get selection height

getSelectionWidth()  : int|null

Get selection width

getSharedSecret()  : string|null

Get shared secret

getToolConfiguration()  : array<string, mixed>|null

Get tool configuration

getUnifiedToolId()  : string|null

Get unified tool ID

getUpdatedAt()  : string|null

Get updated at timestamp

getUrl()  : string|null

Get URL

getUserNavigation()  : array<string, mixed>|null

Get user navigation configuration

getWorkflowState()  : string|null

Get workflow state

paginate()  : PaginationResult

Get paginated results with metadata

save()  : self

Save the current external tool (create or update)

setAccountNavigation()  : void

Set account navigation configuration

setApiClient()  : void

Set the API client

setAssignmentSelection()  : void

Set assignment selection configuration

setConsumerKey()  : void

Set consumer key

setContextId()  : void

Set context ID

setContextType()  : void

Set context type

setCourseHomeSubNavigation()  : void

Set course home sub navigation configuration

setCourseNavigation()  : void

Set course navigation configuration

setCreatedAt()  : void

Set created at timestamp

setCustomFields()  : void

Set custom fields

setDeploymentId()  : void

Set deployment ID

setDescription()  : void

Set external tool description

setDomain()  : void

Set domain

setEditorButton()  : void

Set editor button configuration

setHomeworkSubmission()  : void

Set homework submission configuration

setIconUrl()  : void

Set icon URL

setId()  : void

Set external tool ID

setIsRceFavorite()  : void

Set RCE favorite status

setIsTopNavFavorite()  : void

Set top navigation favorite status

setLinkSelection()  : void

Set link selection configuration

setMigrationSelection()  : void

Set migration selection configuration

setName()  : void

Set external tool name

setNotSelectable()  : void

Set not selectable status

setPrivacyLevel()  : void

Set privacy level

setResourceSelection()  : void

Set resource selection configuration

setSelectionHeight()  : void

Set selection height

setSelectionWidth()  : void

Set selection width

setSharedSecret()  : void

Set shared secret

setToolConfiguration()  : void

Set tool configuration

setUnifiedToolId()  : void

Set unified tool ID

setUpdatedAt()  : void

Set updated at timestamp

setUrl()  : void

Set URL

setUserNavigation()  : void

Set user navigation configuration

setWorkflowState()  : void

Set workflow state

toArray()  : array<string, mixed>

Convert external tool to array Note: Shared secret is excluded for security reasons as it should never be exposed

toDtoArray()  : array<string, mixed>

Convert external tool to DTO array format

update()  : self

Update an external tool in the default account context

updateInContext()  : self

Update an external tool in a specific context

validateConfiguration()  : bool

Validate external tool configuration

castValue()  : DateTime|mixed

Cast a value to the correct type

checkApiClient()  : void

Check if the API client is set, if not, instantiate a new one

convertPaginatedResponseToModels()  : array<string|int, static>

Helper method to convert paginated response data to model instances

createConfiguredHttpClient()  : HttpClient

Create an HttpClient with configured middleware

createPaginationResult()  : PaginationResult

Helper method to create PaginationResult from paginated response

getEndpoint()  : string

Get the API endpoint for this resource

getPaginatedResponse()  : PaginatedResponse

Helper method to get paginated response from API endpoint

getResourceIdentifier()  : string

Get the resource identifier for API endpoints

populate()  : void

Populate the object with new data

isValidUrl()  : bool

Validate URL for security (HTTPS only, no malicious schemes)