Say 👋 hello to BusyBee, your AI-powered learning & teaching companion for Buzz. Learn more!

Administrator

How do I set up Skyward SIS sync in my Buzz domain?

  • Updated:
    info
    Created:

Buzz supports integration with Skyward SIS for rostering of users, courses, enrollments, and observers and grade passback through the 1EdTech OneRoster specification. The sync makes rostering easy, automated, and secure.

OneRoster is a 1EdTech specification for exchanging data between systems. Commonly, this exchange will happen between the student information system (SIS) and the learning management system (LMS). Buzz supports OneRoster 1.1.

Only Buzz users with the Administrator role in the domain can set up and review SIS sync information.

1. In Skyward's Qmlativ: Configure the integration

In this section, follow the steps to do one of the following:

For use by Agilix support: Internal support article

1.1. Configure a new integration with Skyward

Follow Skyward's directions to configure the integration with Buzz.

This integration uses Key and Secret authentication, meaning Skyward and Buzz require matching values for the following:

  • Key: Buzz has no special requirements for the key, so create it when configuring Skyward and save it to use in your Buzz configuration.
  • Secret: Buzz has no special requirements for the secret. When adding integration access for Buzz in Qmlativ, you have the option to generate a secret. You should generate that secret and save it to use in your Buzz configuration.

Instructions about how to use Qmlativ are available from Skyward on request: Skyward Support Options

When you have configured Skyward, continue to Section 2: In Buzz: Configure your SIS sync settings for Skyward.

1.2. Migrate an existing Skyward integration

Migrating your existing Skyward integration from "API User Access" to "Integration Access"

Skyward has transitioned to an improved method of authenticating integrations called Integration Access (formerly API User Access).

As of 10/1/2025, Buzz supports the new Integration Access method using Qmlativ APIs. Follow the steps in this section to migrate.

Request instructions from Skyward about how to use Qmlativ: Skyward Support Options

Sign into Skyward's Qmlativ:

  1. Open the main menu.
  2. Select Administrative Access.
  3. Select API.
  4. Select Integration.
  1. Find Agilix Buzz in the Integrations list and click the open button.
  1. Open the Integration Accesses tab.
  2. Click Add Integration Access to add a new access record.
  1. In the Integration Access screen, complete the following:
    • Name (required): A “friendly” name that allows the district to easily identify the Integration Access and allow the district to differentiate it from another Integration Access for the same Integration. It is helpful to use the Integration’s name plus the year or purpose of the access (e.g., “Agilix Buzz 2023” or “Agilix Buzz Vendor Testing”). Note: This name does not affect the access credentials used to connect to the API(s).
    • Description (optional): This description allows you to provide more details on the purpose of the Integration Access if the Name field does not provide enough context.
    • Integration (required): The Integration will be automatically set to Agilix Buzz.
    • Key (required): This key functions as the Client Key or “username” by Buzz when authenticating with Qmlativ’s APIs. Buzz has no special requirements for the key, so you can create it here and save it to use in your Buzz configuration.
    • Authentication Type (required): The indicates the type(s) of authentication are available to the third-party vendor when authenticating with Qmlativ. Skyward recommends setting this option to “Any”, as this will allow the vendor to access the Integration using their preferred authentication type, and it will not require any changes to be made if other authentication types are added or removed in the future.
    • Is Active (required): Indicates whether the Integration Access is active.
    • Effective Date (required): The date from which the Integration Access becomes available to the third-party vendor.
  2. Choose the existing OneRoster Configuration (which is the same option chosen with your previous User Access integration).
  3. Save.
  1. When you get confirmation that the process was completed successfully, click Generate Secret.
  1. On the Generate Secret screen, click Copy and save the secret to use in your Buzz configuration. Note: Be sure to copy the secret as it is not retrievable when you close this screen.
  2. Check the I have copied this data box.
  3. Click Run Process.

When you have configured Skyward, continue to Section 2: In Buzz: Configure your SIS sync settings for Skyward.

2. In Buzz: Configure your SIS sync settings for Skyward

Once you have configured Skyward, you can set up the sync in Buzz:

  1. Open the More menu on the Admin > Domain screen, and select SIS sync.
  1. Click Edit settings.
  1. On the SIS settings [Beta] card, check the Allow rostering from the SIS box to use the OneRoster REST API to sync your data and provide the following values:
    • Use Skyward as the SIS name. Enter this exactly with no extra spaces.
    • API Base URL (acquire from your SIS).
    • Authentication method: Select Key and secret and provide:
      • API Key (required, this must match the key used in Qmlative).
      • API Secret (required, acquire from your SIS; this is generated in Qmlative).
      • API Token URL (optional, acquire from your SIS).

For direction on additional sync settings, follow Steps 4-9 in Set up your SIS sync settings.

3. In Buzz: Sync your data

Once you have set up your SIS sync settings, you can sync your data using OneRoster's REST APIs, which enables direct system exchanges:

  1. Select the API sync tab on the SIS sync screen.
  2. Check the Validation-only mode box if you want to test for errors and get status messages before updating anything (recommended).
  3. Click Start API sync.
  4. Review sync Status report.

When you're satisfied with the Status, uncheck the Validation-only mode box and click Start API sync to start syncing.

Best practices

  • You can sync anytime you need, but we recommend syncing no more frequently than every 12 hours.
  • You can schedule the API sync to occur daily by reaching out to Agilix Support.

4. In Buzz: Review sync Status

The Admin > SIS Sync > Status screen displays:

  1. Your sync history.
  2. Details, including successes/failures.

If you entered an email address in your SIS Sync settings, you will also receive a confirmation email.

forum

Have a question or feedback? Let us know over in Discussions!