Configuring LTI Pro 1.3 for Canvas Calendar and Conversations

Last Updated:

The LTI Pro app enables users to post Zoom meetings scheduled with LTI to Canvas Calendar, and enables Canvas Conversations to deliver notifications when Zoom meetings are created, edited or deleted.


To enable this integration, you must enter the Canvas developer keys into the Zoom LTI Pro configuration.

Associating Zoom meetings to Calendar course events

To associate Zoom meetings to the respective Calendar course events, you must add a custom parameter in the external tool configuration and set a value for the LTI Attribute name under the tracking field that matches the custom field key.

  1. Log into Canvas as an administrator, navigate to the LTI Developer Key you created for the LTI Pro 1.3 installation, and click the edit icon.
  2. Click Additional Settings. In Custom Fields, enter this string and save: [LTI Attribute Name]=$Canvas.course.id
    Example: canvas_course_id=$Canvas.course.id

Configure the Tracking Field in the LTI Pro app

  1. Log into the Zoom Marketplace as your account administrator, and configure the LTI Pro app.
  2. Under the Tracking Field section, click Edit for your tracking field.
  3. In the LTI Attribute Name field, enter the tracking ID, and save. Example: canvas_course_id.

Enabling LTI Pro to communicate with the Canvas API

To enable LTI Pro to communicate with the Canvas API, you create a new API Developer Key, and add the OAuth Redirect URL from the LTI Pro app.

  1. Sign into the App Marketplace as an account administrator.
  2. Select Developer, click LTI Pro App, and Configure.
  3. On the LTI Credentials page, click Edit next to credentials for your LTI instance.
  4. Copy the OAuth Redirect URL.
  5. In Canvas, add a new API Developer Key.
  6. Login to Canvas with admin privileges.
  7. Click Admin, choose an account, and click Developer Keys.
  8. On the Developer Keys page, click +Developer Key, then click +API Key.
  9. Configure the Developer Key Settings:
    • Enable Enforce Scopes.
    • Select Calendar Events and Conversations.
    • Set Key Name to Zoom LTI Pro Calendaring/Conversations.
    • In the Redirect URL field, paste the Oauth Redirect URL, and then save.
  10. Set the developer key State to ON.

Configuring Calendar and Conversation scopes

To define the LTI Pro app interaction with the Canvas API, configure the Calendar and Conversation scopes.

  1. Sign into the App Marketplace as an account administrator.
  2. Select Developer, click the LTI Pro App, and Configure.
  3. Ensure you are on the LTI Canvas configuration page and select 3rd party Credentials.
  4. Enable Conversation and Calendar, as needed.
    Conversation delivers notifications to all users in a course when meetings are created, edited or deleted.
    It also delivers notifications when recordings are completed.
    Note: You must enable Cloud Recording Link for Students and set Recordings to Students to All.
  5. Enable Enforce Scopes and modify as needed:
    • Conversation is disabled: remove all scopes that include /conversations/.
    • Calendar is disabled: remove all scopes that include /calendar_events/.

Adding the Canvas API and LTI Keys to the LTI Pro app

  1. Ensure you are on the LTI Canvas configuration page and select 3rd party Credentials.
  2. Click Edit on the instance you created for the LTI Pro 1.3 integration.
    The Edit screen will appear as below.


The following table and illustration describes where you can get the information to enter in each field.

Field Description
LTI Canvas Site Domain The domain of your Canvas site.
Developer ID The Developer ID from the Canvas API Developer Key.
Developer Key In the Canvas API Developer Key, click Show Key to display and then copy the key to LTI Pro.
Client ID The Developer ID from the Canvas LTI Developer Key for LTI 1.3. (This should already be configured.)


3. Click Save.

Zoom Community

Join the 100K+ other members in the Zoom Community! Login with your Zoom account credentials and start collaborating.