Skip to main content

Schoolbox Groups Integration

This article is for IT Admins. This will provide steps on setting up Clipboard to Schoolbox Groups integration.

This article is intended for IT Admin users.

Wondering what the Schoolbox Groups Integration is all about?

The Schoolbox Groups Integration is an extension of the existing Schoolbox integration, the Schoolbox Calendar integration, which can be viewed in this article here.

While the Schoolbox Calendar integration syncs Clipboard and Schoolbox Calendars, the Schoolbox Groups Integration takes it a step further.

What is the Schoolbox Groups Integration?

In simple terms, it connects Clipboard Teams to Schoolbox Groups. This means that the membership of Groups in Schoolbox stays automatically updated with the membership of Teams in Clipboard.

Here is a webinar hosted by Schoolbox and Clipboard on how this integration works.

Why integrate using the Schoolbox Groups Integration?

By making this connection, you eliminate the need for manual updates. The integration ensures that the membership of your Groups in Schoolbox mirrors the membership of your Teams in Clipboard.

This not only saves time but also streamlines the process, eliminating the hassle of maintaining separate memberships in both Clipboard and Schoolbox.

This integration empowers the Schoolbox Groups feature, allowing your school to manage various extracurricular groups seamlessly without the need for double-handling.

Important: You may choose to test these setup steps using your Schoolbox staging instance before moving to the Schoolbox production environment.

If so, please contact [email protected] before you connect your production Schoolbox account to your Clipboard account, so that any remaining testing data on Clipboard can be removed.

How to set up the Schoolbox Groups Integration

To enable Schoolbox Groups integration in Clipboard, we will need the following:

  • Schoolbox URL

  • A Schoolbox Superuser token

The Clipboard to Schoolbox Groups integration will run with a frequency of every 30 minutes from Clipboard.

Acquiring the Schoolbox URL

Most schools have their Schoolbox URL customised, so we need to ensure we have the right URL for your school to get the integration running.

The easiest way to get the right Schoolbox URL is to log into your Schoolbox environment and copy it from the address bar of your browser.

Acquiring a Superuser Token

During the integration process, Clipboard will make a number of API requests to Schoolbox to retrieve and update group memberships in Schoolbox. To achieve this, we need a token from a Superuser in Schoolbox to authenticate our requests.

You can follow the steps below to create a token.

  1. Click on your avatar in the top-right corner and click Administration.

2. In the left menu, hover over User Management, then click on Home.

3. In the User Management Home page, search for the Superuser you will use for this integration and click Modify.

4. In the Options section, confirm that this user is indeed a Superuser.

5. Once confirmed, scroll down to the Tokens section and click Create Token.

6. In the popup, copy the text in the grey box and save it somewhere else before you close it.

This token only appears once, so please ensure you have saved it.

Enabling the Integration

In Clipboard, go to the Integrations page. Click the Configure button in the Schoolbox tile.

In the Schoolbox Setup card, click Edit, enable the integration, enter your token and Schoolbox URL and save.

Mapping Schoolbox Groups

To map your Clipboard Teams to your Schoolbox Groups, click the Add Mapping button in the Schoolbox Groups Mapping Card.

Search and add the Clipboard Team in the Clipboard Teams field. In the Schoolbox Groups field, enter the respective Schoolbox Group IDs.

To add more mapping, click the Add Another Mapping button; otherwise, click Save.

We support the following Clipboard Teams to Schoolbox Groups mappings:

  • One-to-one

  • One to many

  • Many-to-one

  • Many-to-many

All mappings set must be unique and not duplicated (An error message will appear otherwise).

Acquiring the Schoolbox Group ID

To get the Schoolbox Group ID, you'll need to:

  • Go to the Groups page in your Schoolbox environment by clicking the button in the top menu.

  • Select All Groups in the left dropdown so you can see all your school groups.

  • Then, find the group you’d like to create a mapping for and go to the group’s homepage. In the address, the number at the end of the URL is the group ID.

    In the example provided below, the group ID for Chess Club is 70.

Once you have acquired the Schoolbox Groups ID and mapped this with your Clipboard Teams, then you have completed the Schoolbox Groups Integration!

Clipboard automatically updates your Teams in the background and syncs with Schoolbox groups every 30 minutes.

The Integrations> Logs page allows you to view successful or unsuccessful integrations into Schoolbox for this integration.

Staff Calendar Sync to Schoolbox

School staff can sync their extracurricular calendars from Clipboard into Schoolbox, allowing them to visualise their curricular and co-curricular commitments efficiently.

To enable this feature, you'll need Schoolbox Enhanced with the Fixtures integration enabled. Additionally, each staff member must have their SIS ID in their Staff Profile on Clipboard. Once these steps are completed, Fixtures with assigned Coaches will appear on the staff member's calendar in Schoolbox.

​​Setting Group Access

Choosing the correct group type and permissions lets you control how users access and interact with your Schoolbox groups. Setting a group type correctly enables Clipboard to recognise the Schoolbox group and sync Clipboard Teams with the corresponding Schoolbox Groups.​​Navigate to the Group PageThe specific Schoolbox page you'd like to configure.


Access Group Management

  • Click the 3-dot menu in the top right corner and select Manage Group.

    Note: Only Superusers will always see this option.
    - If are three dots in the top right corner, the page is recognised as a Group.

    - If there are no dots, then it is not a Group.


Select one of the following levels of access:

Private - A 'Private Group' requires a Group Admin to add users to the Group. This page will not appear in the 'Groups I can join' page. Users cannot choose to leave the group.

or

Moderated - A Moderated Group requires a Group Admin to approve a request to join the Group. Where a page has the folder permissions set to 'Read' for a role, it will appear on the 'Groups I can join' page. Users can also choose to leave the group.


You can also visit Schoolbox's support article on managing your groups for more information via: https://help.schoolbox.com.au/homepage/2874

Did this answer your question?