Canvas by Instructure Setup Guide Lite

Follow our setup guide to connect Canvas by Instructure to Fivetran.

Prerequisites

To connect Canvas by Instructure to Fivetran, you need a Canvas by Instructure account with API access.

Setup instructions

Find Canvas by Instructure domain

Find your Canvas by Instructure domain in your Instructure URL and make a note of it. You will need it to configure Fivetran.

For example, if your Canvas by Instructure URL is https://companyname.instructure.com/, then your domain is companyname.instructure.com.

Generate client ID and client secret

1. Log in to your Canvas by Instructure account.

2. On the left navigation menu, click Admin and select your account.

3. Click Developer Keys.

4. In the +Developer Key drop-down menu, and select the +API Key option.

5. Set up the developer API key:

   • Key Name: Enter a descriptive name for the API key (e.g., Fivetran).
   • Owner Email: Enter the email of the person who will own and maintain the integration.
   • Redirect URIs: Enter the domains where tokens are requested, not your Canvas URL. To avoid mixed content browser errors, use https.

     IMPORTANT: You must enter redirect URIs with https://fivetran.com/integrations/canvas_by_instructure/oauth2/return to fetch the code required to authenticate API endpoints.

   • Redirect URI (Legacy): Enter the URI for the key redirect (if applicable). This field allows you to set the previous URI for a tool. This field is being deprecated.
   • Vendor Code (LTI 2): Not required to integrate with Fivetran. Use only for LTI 2 tools and apps. This is a unique registered code that identifies the vendor or developer of the third-party tool.
   • Icon URL: The URL of the icon for your developer tool. This URL is presented to the user to approve authorization for the tool. To avoid mixed content browser concerns, use https.
   • Notes: Add notes that explain the key's purpose or configuration.
   • Test Cluster Only: Select this checkbox to create a developer key that can only be used in the Canvas test environment.
   • Enforce Scopes: Select this checkbox if you want to reduce the scope of access for the API key. By default, the key will have access to all endpoints available to the authorizing user.

6. Click Save to generate the Client ID and Client secret.

7. Click Show Key under the Details column to display the Client Secret.

8. Make a note of the Client ID and Client secret. You will need them to configure Fivetran.

Finish Fivetran configuration

1. In the connector setup form, enter your chosen Destination schema name.

2. Enter the Client ID and Client secret.

3. Enter your Canvas by Instructure domain.

4. Click Authorize to grant Fivetran access to your Canvas by Instructure account.

5. (Hybrid Deployment only) If your destination is configured for Hybrid Deployment, the Hybrid Deployment Agent associated with your destination is pre-selected in the Select an existing agent drop-down menu. To use a different agent, select the agent of your choice, and then select the same agent for your destination.

6. Click Save & Test. Fivetran will take it from here and sync your Canvas by Instructure data.

Related articles

description Connector Overview

account_tree Schema Information

assignment Release Notes

settings API Connector Configuration

home Documentation Home