Setting up Canvas with AI Companion

The Canvas LMS AI Connector enables natural language interactions with Canvas courses through the REST API. Teachers and students can manage announcements, content, grades, and reports through conversational commands, streamlining course administration while maintaining secure authentication.

Zoom account owners or admins must install the Canvas for Zoom app for their account, during which they configure the connection between Canvas and Zoom.

Once configured, learn how to use Canvas within AI Companion.

Requirements for installing and configuring the Canvas for Zoom app

• Zoom account owner or admin privileges
• Canvas account owner or admin privileges
• Custom AI Companion add-on
• Allow AI Companion to perform tasks in third-party apps enabled

How to configure the Canvas for Zoom app

To configure the Canvas for Zoom connector, an admin must create an API Key in Canvas, then use that to configure the app in the Zoom App Marketplace.

Create an API Key in Canvas

1. Sign in to Canvas as a Canvas admin.
2. In the left sidebar, click Admin then Developer Keys.
3. Create an API Key.
4. Configure the following settings:
   • In the Key Name field, enter Zoom Canvas Connector.
   • In the Redirect URIs field, enter the following:

     https://integrations.zoom.us/connectors/oauth/zXaL6YXyTYiag5w6mnf4dw/authorized

   • (Optional) In the Icon URL field, enter the following:

     https://media.ffycdn.net/us/zoom-video-communications/TM2yntcD58CmV921jBBa.svg?width=2400&mod=v1/max=2400

5. Select the check box next to each scope you want to enable and clear the check box next to each scope you do not want to enable. Available scopes:
   • url:GET|/api/v1/courses
   • url:GET|/api/v1/courses/:course_id/assignments
   • url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id
   • url:GET|/api/v1/courses/:course_id/discussion_topics
   • url:GET|/api/v1/courses/:course_id/discussion_topics/:topic_id
   • url:GET|/api/v1/courses/:course_id/enrollments
   • url:GET|/api/v1/courses/:course_id/modules
   • url:GET|/api/v1/courses/:course_id/quizzes
   • url:GET|/api/v1/courses/:course_id/quizzes/:id
   • url:GET|/api/v1/courses/:course_id/quizzes/:quiz_id/questions
   • url:GET|/api/v1/courses/:course_id/quizzes/:quiz_id/submissions
   • url:GET|/api/v1/courses/:id
   • url:GET|/api/v1/users/:id
   • url:POST|/api/v1/courses/:course_id/assignments
   • url:POST|/api/v1/courses/:course_id/discussion_topics
   • url:POST|/api/v1/courses/:course_id/modules
   • url:POST|/api/v1/courses/:course_id/modules/:module_id/items
   • url:POST|/api/v1/courses/:course_id/pages url:POST|/api/v1/courses/:course_id/quizzes
   • url:POST|/api/v1/courses/:course_id/quizzes/:quiz_id/questions
   • url:PUT|/api/v1/courses/:course_id/quizzes/:id
6. Click Save.
7. Take note of the client key and secret, to enter in steps 4.2 and 4.3 when configuring Canvas in the Zoom App Marketplace.

Configure Canvas in the Zoom App Marketplace

1. Sign in to the Zoom App Marketplace.
2. In the top-right corner, search for Canvas for Zoom.
3. Click Add.
4. In the Configure Canvas window, enter the following information:
   1. In the Domain field, enter your instructure domain.
   2. In the Client ID field, enter the API Key from Canvas.
   3. In the Client Secret field, enter the API secret from Canvas.
   4. In the Scopes field, enter the following list of scopes. All tools configured are covered by the scopes listed. If you didn’t enable certain scopes in step 5 of Create an API Key in Canvas, then remove them from this list.
      • url:GET|/api/v1/courses url:GET|/api/v1/courses/:course_id/assignments url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id url:GET|/api/v1/courses/:course_id/discussion_topics url:GET|/api/v1/courses/:course_id/discussion_topics/:topic_id url:GET|/api/v1/courses/:course_id/enrollments url:GET|/api/v1/courses/:course_id/modules url:GET|/api/v1/courses/:course_id/quizzes url:GET|/api/v1/courses/:course_id/quizzes/:id url:GET|/api/v1/courses/:course_id/quizzes/:quiz_id/questions url:GET|/api/v1/courses/:course_id/quizzes/:quiz_id/submissions url:GET|/api/v1/courses/:id url:GET|/api/v1/users/:id url:POST|/api/v1/courses/:course_id/assignments url:POST|/api/v1/courses/:course_id/discussion_topics url:POST|/api/v1/courses/:course_id/modules url:POST|/api/v1/courses/:course_id/modules/:module_id/items url:POST|/api/v1/courses/:course_id/pages url:POST|/api/v1/courses/:course_id/quizzes url:POST|/api/v1/courses/:course_id/quizzes/:quiz_id/questions url:PUT|/api/v1/courses/:course_id/quizzes/:id
   5. Under Admin settings, click the Set these configurations as default for all users toggle to enable it. Then click the lock icon to lock the app configuration for all users.
5. Click Submit.
6. Complete the installation.

How to install the Canvas for Zoom app

Once configured by an admin, users can install the Canvas for Zoom app from the Marketplace.

1. Sign in to the Zoom App Marketplace.
2. In the top-right corner, search for Canvas for Zoom.
3. Click Authorize.
4. Complete the installation.

How to remove the Canvas for Zoom app

1. Sign in to the Zoom App Marketplace as the account admin.
2. In the top-right corner, click Manage.
3. In the navigation menu, click Added Apps.
4. Next to Canvas for Zoom app, click Disconnect.

How your data is used

Zoom's Canvas Marketplace app allows Zoom Communications, Inc., access to your Canvas course information records. To do so, you’ll need to share Canvas permissions. You decide what permissions to share with Zoom according to the enabled scopes in your Canvas API Key.

• Course information (course list, course details, enrollments): Used to display your courses, verify course access permissions, and show enrollment information when managing course content.
• User profile (user ID, name, role): Used to authenticate your Canvas identity and determine your permissions (teacher, student, TA) for accessing and creating content.
• Assignment data (assignment list, submission details): Used to display assignments, check submission status, and create new assignments based on class discussions.
• Discussion topics (topic list, topic details, posts): Used to view existing discussions, create new discussion forums, and continue conversations from Zoom meetings.
• Quiz information (quiz list, quiz details, questions, submissions): Used to display quizzes, create new assessments, add questions, and review student performance data.
• Module content (module list, module items): Used to access course modules, display learning materials, and organize content within your courses.
• Page content: Used to create and display wiki pages that document class discussions and learning materials.

By authorizing this connection, the Canvas app maintains ongoing access to your information.