For Developers

Implementation Details

How the Integration Works

Edlink's integration with Canvas facilitates synchronization of key educational data, including users, courses, enrollments, assignments, and submissions. The integration leverages Canvas API endpoints to pull data and transform it into Edlink's unified data model. Canvas objects like Sections, Courses, and Users are mapped to Edlink objects through a standardized transformation process.

Data Mapping

Canvas EntityEdlink Entity
AccountSchool
SectionClass
CourseCourse
UserPerson
EnrollmentEnrollment
TermSession
AssignmentsAssignment
SubmissionsSubmission

Additional Notes

Canvas Scopes

Edlink uses the Canvas GraphQL API to sync efficiently with Canvas. However if scopes are enabled the GraphQL becomes inaccessible. This can result in long delays when syncing data. It is recommended not to enable scopes for the Edlink integration. Read more.

Canvas Sections and Assignments

If you have multiple sections under a single course in Canvas, and you are interested in creating Assignments, you might consider following our parent_id-based approach to avoid the appearance of "duplicate" assignments in the Canvas UI. This is optional, and up to you and the needs of your product.