Synergy Integration Overview

Canvas has developed an automated integration with Synergy using APIs made available from OneRoster 1.1. The APIs allow Synergy to share rostering data to Canvas and for Canvas to post grades back to Synergy.

As an admin, you can review the integration functionality and limitations and request the integration for your institution.

Integration Overview

The OneRoster integration works bi-directionally:

  • Synergy to Canvas Provisioning: When you make changes in Synergy (to users, courses, enrollments, etc.), those changes are reflected in Canvas after a nightly, one-way transfer from your SIS's OneRoster 1.1 API to Canvas.
  • Canvas to Synergy Grade Passback (GPB): When instructors make changes or updates to course assignments and student grades in Canvas, those changes are sent to your SIS using OneRoster 1.1 API. Learn about syncing grades from Canvas to the Synergy gradebook.

Note:OneRoster provisioning is required for GPB functionality.

Supported Objects

Provisioning:

  • Courses
  • Enrollments
  • Sections
  • Staff
  • Students
  • Sub-accounts
  • Terms

GPB:

  • Course Grades/Gradebook Scores
  • Graded Assignments
  • Graded Discussions
  • Graded Quizzes

Synergy Integration Prerequisites

Before implementing the Synergy Canvas integration, your institution must meet the following requirements:

  1. Request your OneRoster 1.1 credentials from Synergy. These OneRoster credentials (API URL, client key, and client secret) should be sent to the Instructure SIS team using a secure Canvas-provided link.
  2. Once you have shared your OneRoster credentials, the Instructure SIS team will verify the integration connectivity.
  3. If your institution is converting from one SIS to another or transitioning from a different integration, the SIS team must perform an evaluation of the integration against your data. The SIS team will contact you with any concerns about converting to the Synergy integration.

Known Synergy Integration Limitations

Only classes created in Synergy using the Synergy gradebook can be provisioned to Canvas. For example, a staff professional development course not using the Synergy grade book will not sync to Canvas.

Next Steps

If you are interested in enabling the Synergy Integration for provisioning, please contact your Customer Success Manager (CSM) for consideration.

Additional Resources