Skip to main content

Updating or Rotating Your Lessonspace API Key

Written by Teachworks Support
Updated this week

If your Lessonspace integration is experiencing issues launching spaces or you get a connection error, the first thing you should check is the status of your API Key. This is a one-time update and is not a recurring task.

Identifying Your Lessonspace API Key Status

You can check the API key status by following the steps below:

  1. Click on Account & Settings and then click on Integrations & Add-ons.

  2. Click on the "Settings" link under the Lessonspace Integration.

Valid API Key - No Changes Required

If your API key is valid and working correctly, your settings page will look like this:

Invalid API Key - New API Key Required

If your API key is invalid or expired and needs to be updated, your settings page will look like this:

How to Generate a New API Key

If your API key is expired or invalid, you can generate a new API key by following these steps:

  1. Login to your Lessonspace Account.

  2. From the Dashboard, click on "Settings" and then click on "Developer".

  3. Generate and copy the new API Key.

  4. In your Teachworks account, click on Account & Settings and then click on Integrations & Add-ons.

  5. Click on the "Settings" link under the Lessonspace Integration.

  6. Paste the new API Key in the "API Key" field.

  7. Submit the form to save your changes.

Teachworks will then automatically communicate with Lessonspace to renew and store your updated API key.

Rotating Your API Key

It's also possible update the API Key periodically for enhanced security measures. This can be done using the "Rotate API key" option on the right-hand side. This will update the API Key in Teachworks and Lessonspace simultaneously.

NOTE: The "Rotate API" feature is only available for companies who have a valid API key. If you have never connected Lessonspace before, please follow our setup guide here: Lessonspace Integration.

Did this answer your question?