Skip to main content
The Canvas connector indexes published pages, published assignments, and active announcements from Canvas LMS courses that the configured access token can access. There is no course picker. Onyx indexes every available course returned by Canvas for that token.

​
How it works

On each refresh, the connector lists the token’s available courses, then processes pages, assignments, and announcements in that order. Pages and assignments are included when their Canvas updated_at falls in the indexing window. Announcements are included when their posted_at falls in the window. Pages without updated_at, assignments without updated_at, and announcements without posted_at are skipped.

​
Before you begin

You need:
  • The HTTPS URL of your Canvas site, such as https://school.instructure.com
  • A Canvas user who can open every course you want Onyx to index
  • Permission in Canvas to create an API access token for that user
  • An Onyx administrator account
The access token has the same Canvas access as the user who created it. Onyx indexes only the available courses, published pages, published assignments, and active announcements that user can see.

​
Configure Canvas

1

Open Canvas account settings

In Canvas, open Account → Settings. You can also go directly to /profile on your Canvas site.
2

Create an access token

In Approved Integrations, select New Access Token (sometimes labeled Add New Access Token).Enter a purpose such as Onyx Connector. Optionally set an expiration date. Leave the expiration empty only if your institution allows non-expiring tokens.Generate the token and copy it immediately. Canvas does not show the full token again.
Treat the token like a password. It authenticates as the Canvas user who created it. Some institutions restrict who can create tokens; if the button is disabled, ask a Canvas admin to grant the Users - manage access tokens permission or to create the token for you.
For Canvas’s own steps, see How do I manage API access tokens in my user account? and Canvas’s OAuth / access token documentation.

​
Configure Onyx

1

Open the Canvas connector

In Onyx, go to Admin Panel → Add Connector and select Canvas.
2

Enter the Canvas access token

Create a credential and paste the token into Canvas Access Token.
3

Enter the Canvas base URL

Give the connector a name. In Canvas Base URL, enter the site URL, such as https://school.instructure.com.Use https. Do not use http. You can omit a trailing slash and /api/v1; Onyx normalizes those if they are included.
4

Choose access type

Select the connector access type:
  • Public makes all indexed Canvas content visible to every Onyx user.
  • Private limits the entire connector to selected Onyx users and groups.
  • Auto Sync Permissions mirrors supported Canvas access controls and is available on Onyx Cloud and Enterprise Edition.
5

Connect and verify

Select Connect. Then open Admin Panel → Existing Connectors, select the connector, and confirm its initial indexing attempt completes.

​
Auto Sync Permissions

With Auto Sync Permissions, Onyx maps Canvas visibility to Onyx users by email. Canvas user emails must match the users’ email addresses in Onyx. Users Canvas returns without an email are not granted access. The token must be able to read course roster emails. When you save a permission-syncing Canvas connector, Onyx probes the first available course’s roster and rejects the connector if no emails are visible. Courses Canvas marks as public, or public to authenticated users, also grant access to an all-users group when the token can list users on the Canvas account. If the token cannot list account users, those course-wide items are limited to the course roster. Section-specific announcements and override-only assignments stay restricted even on a public course.
Review the access type before connecting. Choosing Public does not preserve Canvas permissions and can expose indexed content to every Onyx user.

​
Troubleshooting

An error such as Canvas API token is invalid or expired (HTTP 401) means the token is missing, revoked, or past its expiration. Create a new access token in Canvas and update the Onyx credential. Confirm Canvas Base URL is the HTTPS site URL for the same Canvas instance that issued the token.
Canvas API token does not have sufficient permissions (HTTP 403) means the Canvas user cannot call the API being used. Indexing needs access to the user’s available courses and to published pages, published assignments, and active announcements in those courses. Permission sync additionally needs roster email visibility on at least one available course.
The URL must include a host and must use https. Enter the Canvas site, for example https://school.instructure.com, not an http URL.
Confirm the token’s Canvas user can open the item. Onyx only lists courses in the available state, only published pages, only published assignments, and only active announcements. Pages and assignments without updated_at, and announcements without posted_at, are skipped on refresh. A course that returns HTTP 404 is skipped for that indexing attempt.
Confirm you are using Onyx Cloud or Enterprise Edition. Reconnect with a token that can read course users with email addresses. Student tokens usually fail this check.
Confirm the user’s Canvas email matches their Onyx email, and that Canvas returned an email for that user on the course roster. Invited and active enrollments are included; other enrollment states are not. Override-only assignments and section-specific announcements are limited to those targets plus teachers, TAs, and designers.
The token cannot list account users. Public-course pages and other course-wide items then use the course roster only. Use a Canvas admin token if you need the all-users mapping for public courses.