Skip to content
English
Visit edly.io
  • There are no suggestions because the search field is empty.

Steps to Integrate Zoom with LTI Consumer

Overview

Integrating Zoom into your course run allows instructors to schedule, manage, and host live video lectures or webinars directly inside a course unit. This integration relies on the LTI Pro application from the Zoom App Marketplace and the native LTI Consumer advanced component in Open edX Studio.

Note: The steps below describe the LTI 1.1 workflow using per-course LTI Passports. Starting with Open edX Ulmo (January 2026), Zoom can also be integrated via the centralized Reusable LTI Store, which uses LTI 1.3 (LTI Advantage). The Reusable LTI Store allows platform administrators to configure Zoom credentials once and make the tool available across all courses without repeating the LTI Passport setup in each course. Contact your Edly administrator for details on LTI 1.3 configuration.

Tip: Ensure you are logged into Open edX Studio with appropriate Admin or Staff permissions before proceeding.

Step 1: Generate Credentials in the Zoom Marketplace

Before setting up anything in Studio, you must generate secure communication keys from your Zoom account.

  1. Sign in to the Zoom App Marketplace.
  2. Search for and install the LTI Pro application.
  3. Open the LTI Pro configuration dashboard and click Create New Credential.
  4. Give your credential a clear name (e.g., Open_edX_Live).
  5. Configure Email Attribute: Scroll down to the Email Attribute Name field and enter exactly: instructor_email
  6. Keep this page open; you will need to copy the generated LTI Key, LTI Secret, and LTI URL in the next steps.

Step 2: Configure the LTI Passport in Studio

To establish a trust relationship between your platform instance and Zoom, you must configure an LTI Passport.

  1. Open your course run in Studio.
  2. From the Settings menu in the top navigation bar, select Advanced Settings.
  3. In the search box, find the LTI Passports field.
  4. Add your credential details inside the list brackets using this strict syntax format: ["zoom:LTI_KEY:LTI_SECRET"]
    • Note: Replace LTI_KEY and LTI_SECRET with the exact alphanumeric strings copied from your Zoom Pro page in Step 1. Keep the zoom: prefix intact.
  5. Click Save Changes at the bottom of the screen.

Step 3: Embed the LTI Consumer Component

With the background handshake established, you can now drop the interactive Zoom window into any target course page.

  1. Navigate to your Course Outline and enter the specific Unit where you want the live meeting portal to reside.
  2. Scroll to the Add New Component panel at the bottom of the unit workspace.
  3. Click the green Problem tile.
  4. Select the Advanced tab inside the problem options bar.
  5. Click LTI Consumer. The interface container block will immediately load onto your unit canvas.

Step 4: Configure the LTI Consumer Settings

You must configure the embedded component to point directly to your Zoom environment.

  1. Find your newly added LTI Consumer component block and click Edit.
  2. Fill out the following configuration fields in the modal window:
    • Display Name: Enter a customer-facing title (e.g., Live Class: Weekly Webinar Portal).
    • LTI ID: Type exactly: zoom (This matches the prefix descriptor you declared in your LTI Passport).
    • LTI URL: Paste the LTI launch URL copied from your Zoom App Marketplace credential page.
    • Custom Parameters: Inside the square brackets, map your account host email using this structure: ["instructor_email=your_zoom_account_email@domain.com"]
  3. Click Save.
  4. Click the Publish button in the right-hand unit status panel to push the configuration live.

Step 5: Scheduling Meetings inside the LMS

Once published, you configure your live class calendar directly inside the live environment player.

  1. Click the View Live Version button at the top right of your unit workspace to open the page inside the LMS.
  2. The interactive Zoom Pro portal interface will load inside the unit viewpane.
  3. Click Schedule a New Meeting.
  4. Adjust your topic names, recurring calendar parameters, duration metrics, and security settings according to your curriculum timeline, then click Save.

Enrolled learners navigating onto this unit page will see the upcoming meeting schedule, countdown clocks, and a Join button as soon as the live lecture goes active.