# Placements Overview {% hint style="warning" %} **Welcome to Our New API Docs!** This is the new home for all things API (previously at [Canvas LMS REST API Documentation](https://api.instructure.com)). {% endhint %} ## Placements Overview Placements are the "entry points" into an External Tool. They determine where an External Tool is visible to users. For placement settings, go to the [Tool Configuration](https://developerdocs.instructure.com/services/canvas/external-tools/file.lti_dev_key_config#placements-params) page. ### List of Supported Placements * [Account Navigation](#account-navigation) * [Assignment Document Processor](#assignment-document-processor) * [Assignment Edit](#assignment-edit) * [Assignment Group Menu](#assignment-group-menu) * [Assignment Index Menu](#assignment-index-menu) * [Assignment Menu](#assignment-menu) * [Assignment Selection](#assignment-selection) * [Assignment View](#assignment-view) * [Collaboration](#collaboration) * [Course Assignments Menu](#course-assignments-menu) * [Course Home Sub Navigation](#course-home-sub-navigation) * [Course Navigation](#course-navigation) * [Course Settings Sub Navigation](#course-settings-sub-navigation) * [Discussion Index Menu](#discussion-index-menu) * [Discussion Topic Menu](#discussion-topic-menu) * [Editor Button](#editor-button) * [File Index Menu](#file-index-menu) * [File Menu](#file-menu) * [Global Navigation](#global-navigation) * [Homework Submission](#homework-submission) * [Link Selection](#link-selection) * [Migration Selection](#migration-selection) * [Module Group Menu](#module-group-menu) * [Module Index Menu (Modal)](#module-index-menu-modal) * [Module Index Menu (Tray)](#module-index-menu-tray) * [Module Menu Modal](#module-menu-modal) * [Module Menu](#module-menu) * [Page Index Menu](#page-index-menu) * [Page Menu](#page-menu) * [Quiz Index Menu](#quiz-index-menu) * [Quiz Menu](#quiz-menu) * [Student Context Card](#student-context-card) * [Submission Type Selection](#submission-type-selection) * [Sync Grades](#sync-grades) * [Tool Configuration](#tool-configuration) * [Top Navigation](#top-navigation) * [User Navigation](#user-navigation) * [Resource Selection ⚠️](#resource-selection) ## Account Navigation name: account\_navigation ![Account Navigation Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-4136ec1ea44decee7ae676b5a28bbaf6c06c2de4%2Faccount_navigation.png?alt=media) ## Assignment Document Processor name: ActivityAssetProcessor ![Assignment Document Processor Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-bd4ddbfa05077c843b7e8be0bf55f7f9959ebbcd%2FActivityAssetProcessor.png?alt=media) ## Assignment Edit name: assignment\_edit ![Assignment Edit Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-1645d73445a2918f469f678f421bb1cb288f4c61%2Fassignment_edit.png?alt=media) ## Assignment Group Menu name: assignment\_group\_menu ![Assignments Group Menu Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-dee37195ff2cafe2dd7fa38a8b50596331cb2b5f%2Fassignment_group_menu.png?alt=media) ## Assignment Index Menu name: assignment\_index\_menu ![Assignments Index Menu Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-66ab8ce99a3002b361a3623c3ae7e6c2c204cc2e%2Fassignment_index_menu.png?alt=media) ## Assignment Menu name: assignment\_menu ![Assignment Menu Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-9bc8fedc46f74cd618c0a1de26a135549e12fabb%2Fassignment_menu.png?alt=media) ## Assignment Selection name: assignment\_selection ![Assignment Selection Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-edc0bdcb3ef371c0df30c7e7a23925c5b79704cd%2Fassignment_selection.png?alt=media) ## Assignment View name: assignment\_view ![Assignment View Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-da6671bf1f97f830df6bd9206ad8501298238ef9%2Fassignment_view.png?alt=media) ## Collaboration name: collaboration ![Collaboration Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-0ae80a9faeb56440d03ac41377374824e823eadf%2Fcollaboration.png?alt=media) ## Course Assignments Menu name: course\_assignments\_menu ![Course Assignments Menu Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-e5bc5fbaf5490dd78b8dd264149ff6dfdbdfe697%2Fcourse_assignments_menu.png?alt=media) ## Course Home Sub Navigation name: course\_home\_sub\_navigation ![Course Home Sub Navigation Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-50b653efb28a8b92490b3e102d79c9ab2690aef5%2Fcourse_home_sub_navigation.png?alt=media) ## Course Navigation name: course\_navigation ![Course Navigation Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-14a80b2a1d61380d985c5eab756c38e4608ea5bd%2Fcourse_navigation.png?alt=media) ## Course Settings Sub Navigation name: course\_settings\_sub\_navigation ![Course Settings Sub Navigation Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-8dbf519e1333e6257e9ab753dd81ecb1587b8c89%2Fcourse_settings_sub_navigation.png?alt=media) ## Discussion Index Menu name: discussion\_topic\_index\_menu ![Discussions Index Menu Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-83602cac1be53df991f325da9866e646a819c0d4%2Fdiscussion_topic_index_menu.png?alt=media) ## Discussion Topic Menu name: discussion\_topic\_menu ![Discussion Topic Menu Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-0ca00e294dd2ed139da3333df4b8075c75a1a04e%2Fdiscussion_topic_menu.png?alt=media) ## Editor Button name: editor\_button ![Editor Button Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-3114a8e18c28927707e3ef10a6db3c9bed7d12f3%2Feditor_button.png?alt=media) ## File Index Menu name: file\_index\_menu ![Files Index Menu Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-6fc3fd2965363c99761ff1eabea7b52bfe6d74dc%2Ffile_index_menu.png?alt=media) ## File Menu name: file\_menu ![File Menu Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-c974796266a20c0da41c844937f39abc5ddc216e%2Ffile_menu.png?alt=media) ## Global Navigation name: global\_navigation ![Global Navigation Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-9eb227062fa5f75f662a431ee82beb30f77abe23%2Fglobal_navigation.png?alt=media) ## Homework Submission name: homework\_submission ![Homework Submission Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-022d92988c14324125a526fc37e741dbff209082%2Fhomework_submission.png?alt=media) ## Link Selection name: link\_selection ![Link Selection Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-051e18827842cc24dcc32e5972c0b9bed241eadb%2Flink_selection.png?alt=media) ## Migration Selection name: migration\_selection ![Migration Selection Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-cf514b1005250951312347ea1a9de3542d523b81%2Fmigration_selection.png?alt=media) ## Module Group Menu name: module\_group\_menu ![A screenshot of the location of the Module Group Menu placement within Canvas, located underneath the three-dot menu in any module group.](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-4a8b7c2482a274c0de381135d6e325f85c9a9a80%2Fmodule_group_menu.png?alt=media) After clicking on the placement: ![A screenshot of the Module Group Menu placement being opened on the right side of the screen as a pop-out window.](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-2f2f162097d710ac4ec6442641c9e9d27a780376%2Fmodule_group_menu_open.png?alt=media) ## Module Index Menu (Modal) name: module\_index\_menu\_modal ![Modules Index Menu (Modal) Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-ed0191c31326812c6f9dc9ff82f88faf989dc8ea%2Fmodule_index_menu_modal.png?alt=media) ## Module Index Menu (Tray) name: module\_index\_menu ![Modules Index Menu (Tray) Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-740ce6992800f5efbc1dbf167d723f2ef2402cea%2Fmodule_index_menu.png?alt=media) ## Module Menu Modal name: module\_menu\_modal ![A screenshot of the Module Menu Modal placement within Canvas, located underneath the three-dot menu in any module group.](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-5b67affeb7573e8d76c80f5dddef1ea50cf76a7d%2Fmodule_menu_modal.png?alt=media) After clicking on the placement: ![A screenshot of the Module Menu Modal placement being opened as a modal in the center of the screen.](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-e31a61f395dc58251c567a8ab148fc6df28dfd95%2Fmodule_menu_modal_open.png?alt=media) ## Module Menu name: module\_menu ![Module Menu Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-b05bca00e705cce46b09762877d2eeefa3052d34%2Fmodule_menu.png?alt=media) ## Page Index Menu name: wiki\_index\_menu ![Pages Index Menu Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-90768561218c4c3fbf35a7988b0f502aa4946c93%2Fwiki_index_menu.png?alt=media) ## Page Menu name: wiki\_page\_menu ![Page Menu Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-0a04e7c1e61571ee804b51ecc013237636269317%2Fwiki_page_menu.png?alt=media) ## Quiz Index Menu name: quiz\_index\_menu ![Quizzes Index Menu Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-0cb6da91dc1a711ad6f047964c74b67379a59a85%2Fquiz_index_menu.png?alt=media) ## Quiz Menu name: quiz\_menu ![Quiz Menu Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-17a8c4e6faca9a84301e70da8d6dad8912ecda9f%2Fquiz_menu.png?alt=media) ## Student Context Card name: student\_context\_card ![Student Context Card Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-1bb7c4604ffc1ceb9a9d576b9172739823aedd73%2Fstudent_context_card.png?alt=media) ## Submission Type Selection name: submission\_type\_selection ![Submission Type Selection Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-bbb353e6acc0558f2185c6b3abe0ecb129159b15%2Fsubmission_type_selection.png?alt=media) ## Sync Grades name: post\_grades ![Sync Grades Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-37da93ca8db1a5224a9fd76f232177b323f30153%2Fpost_grades.png?alt=media) ## Tool Configuration name: tool\_configuration ![Tool Configuration Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-4b4b928cfb4c81e0c3d47bf97cf241e7d72e2ed4%2Ftool_configuration.png?alt=media) ## Top Navigation name: top\_navigation ![Top Navigation Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-5d899e35f08aef64ebbded0026e153b193aab22e%2Ftop_navigation.png?alt=media) ## User Navigation name: user\_navigation ![User Navigation Screenshot](https://3935729257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB0qnrcLHZo7GMoCVWI3W%2Fuploads%2Fgit-blob-1cae22cb38cdf614674a997301fc2fff2990cc6a%2Fuser_navigation.png?alt=media) {% hint style="warning" %} Deprecated placements {% endhint %} ## 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](#assignment-selection) and [link\_selection](#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](https://developerdocs.instructure.com/services/canvas/external-tools/lti/placements/file.assignment_selection_placement) and [here](https://developerdocs.instructure.com/services/canvas/external-tools/lti/placements/file.link_selection_placement). *** This documentation is generated directly from the Canvas LMS source code, available [on Github](https://github.com/instructure/canvas-lms).