Integration Guide

If you are a student, please share this page with your school's IT department so they can enable the necessary Canvas integration to allow you to use MyTextMate. You can also request your school here and we will try to contact them on your behalf.

MyTextMate is a student engagement tool that lets students receive daily personalized text messages about their upcoming due dates. Before students can use MyTextMate, they need a Canvas Account Administrator to turn on MyTextMate's developer key.

About MyTextMate's Developer Key

Developer keys let third-party applications connect to user's Canvas accounts. MyTextMate's developer key is inherited, meaning it has been vetted and approved by Instructure. It is also scoped, meaning it can only access a limited number of endpoints through the Canvas API. These are the only endpoints that MyTextMate can access in an authenticated user's account:

  1. url:GET|/api/v1/planner/items
  2. url:GET|/api/v1/courses
  3. url:GET|/api/v1/users/:user_id/profile
  4. url:PUT|/api/v1/users/self/course_nicknames/:course_id
  5. url:GET|/api/v1/users/:user_id/observees
  6. url:GET|/api/v1/users/:user_id/planner/items

How to Turn On MyTextMate's Developer Key

MyTextMate's developer key can be found in Canvas's developer key management UI. This is how to locate it after logging in as an administrator:

  1. Click Admin and select your school or district.
  2. Click Developer Keys from the admin side panel.
  3. Click Inherited on the top of the page, scroll down, and click Show All Keys.
  4. Find MyTextMate and click On.
Screenshot of MyTextMate's developer key

How Students Authorize MyTextMate

Once MyTextMate's developer key is turned on, please let us know by filling out this form or sending us an email. This will notify us to add your school to MyTextMate's companion app. There, students can select their school to authorize MyTextMate to send them daily personalized text messages about their upcoming due dates from Canvas.

The following screenshots demonstrate the authorization flow.

Screenshots showing how students can allow MyTextMate to access their account.