External tool settings

Jump to: navigation, search

Note: You are currently viewing documentation for Moodle 2.6. Up-to-date documentation for the latest stable version of Moodle may be available here: External tool settings.


A teacher can add an external tool from their course page and an administrator can make an external tool available to all teachers on the site.

Adding a new external tool to a course

  1. With the editing turned on,in the section you wish to add your external tool, click the "Add an activity or resource" link (or, if not present, the "Add an activity" drop down menu )and choose External tool
  2. This will take you to the settings page titled "Adding a new external tool". All settings may expanded by clicking the "Expand all" link top right.
  3. If the external tool has not been configured by the administrator, you will need to have in advance the correct URL, consumer key and secret. These should have been provided to you by the managers of the LTI compliant website you are going to be connecting to. Click "Show more" to access the consumer key and secret fields.

General settings

General settings before expanding. When expanded, extra options are available.


  • Activity name - give the title you wish the students to see on the course page
  • External tool type -this is how Moodle communicates with the tool provider. If in doubt, leave as default. If your administrator has made a tool available sitewide, you will be able to select it here:
Selecting a preconfigured tool
  • Launch URL - This is the URL for connecting to site.
  • Launch container- this is how the external tool will be displayed.
    • Default -if in doubt; leave as default
    • Embed - the external tool will be embedded in the Moodle course page with blocks and navigation bar
    • Embed without blocks - the external tool will be embedded in the Moodle course page but without blocks
    • New Window - the external tool will open in a new window. (A new window or tab will open with the External tool and the old browser window containing the course page will not change.)

The following settings are available by clicking ""Show more":

  • Activity description - give a short description here
  • Display description on course page - choose to show the description along with the activity name
  • Display activity name when launched - have this appear when the student clicks the link.
  • Display activity description when launched - have this appear when the student clicks the link.
  • Secure launch URL -
  • Consumer key -this tells the connecting LTI compliant site that your Moodle is allowed to connect. The "tool provider", ie the manger of the connecting LTI compliant site will issue you with this key. If you are merely linking to a tool with no secure access or gradebook sharing then you won't need a consumer key.
  • Shared secret - this is the "password" to connect to the tool - the LTI compliant site.
  • Custom parameters - most times you can leave this blank. The tool provider might use this to allow you to display a specific resource.
  • Icon URL - you can display a different icon from the default External Tool icon by entering its URL here
  • Secure Icon URL - enter the URL of a different icon here if your students are accessing Moodle securely via SSL.

Privacy settings

(These settings are collapsed by default)

Privacy settings expanded
  • Share launcher's name with the tool - this means that the student's name will be displayed on the connected site as in this example
  • Share launcher's email with the tool - this means that the student's email will be displayed on the connected site as in this example
  • Accept grades from the tool - if this is checked, the connecting site will send back grades to Moodle's gradebook. See Using External tool for more information on this.

Common module settings

See Common module settings

Restrict access/Activity completion

(These settings are collapsed by default)

These settings are visible if Conditional activities and Activity completion have been enabled in the site and the course.



Site administration settings

Adding a tool sitewide

An administrator can configure external tools in Settings > Site administration > Plugins > Activity modules > External tool so that they are available across the site. There are tabs to add an external tool, to view those which are pending and to view those which have been rejected:

Setting up a new external tool

External tool capabilities