Instructure Developer Documentation Portal

Placements Overview

Placements Overview

Placements are the "entry points" into an External Tool. They determine where an External Tool is visible to users.

List of Supported Placements

name: account_navigation

Assignment Edit

name: assignment_edit

name: assignment_group_menu

name: assignment_index_menu

name: assignment_menu

Assignment Selection

name: assignment_selection

Assignment View

name: assignment_view

Collaboration

name: collaboration

name: course_assignments_menu

name: course_home_sub_navigation

name: course_navigation

name: course_settings_sub_navigation

name: discussion_topic_index_menu

name: discussion_topic_menu

Editor Button

name: editor_button

name: file_index_menu

name: file_menu

name: global_navigation

Homework Submission

name: homework_submission

Link Selection

name: link_selection

Migration Selection

name: migration_selection

name: module_group_menu

After clicking on the placement:

name: module_index_menu_modal

name: module_index_menu

name: module_menu_modal

After clicking on the placement:

name: module_menu

name: wiki_index_menu

name: wiki_page_menu

name: quiz_index_menu

name: quiz_menu

Student Context Card

name: student_context_card

Submission Type Selection

name: submission_type_selection

This is a restricted placement, contact your CSM (Customers) or Developer Relations (Partners) for more information.

Sync Grades

name: post_grades

Tool Configuration

name: tool_configuration

name: top_navigation

This is a restricted placement, contact your CSM (Customers) or Developer Relations (Partners) for more information.

name: user_navigation

Deprecated placements

Resource Selection

name: resource_selection ⚠️

This is a placement that once was the default for 1.1 tools, and was one of the very first placements for Canvas. It makes the tool show up both in - assignment_selection and link_selection (new module item), but is deprecated now.

For 1.3 tools using this placement we highly recommend to use assignment_selection or link_selection instead! You can read about those in details here and here.

© Instructure, Inc. Generated on Wed Nov 6 14:19:59 2024 This documentation is generated directly from the Canvas LMS source code, available on Github.

Last updated 12 days ago

Copyright © 2024 Instructure, Inc. All rights reserved.