iSAMS OAuth 2.0 Integration Setup for SchoolCloud Parents' Meetings


iSAMS OAuth 2.0 Integration Setup for Parents' Meetings

This guide explains how to generate an OAuth 2.0 Client ID and Client Secret in iSAMS and configure the connection within Parents' Meetings.


Before You Start

You will need:

  • An iSAMS account with access to Control Panel and API Services Manager
  • An administrator account in Parents' Meetings
  • Your school's iSAMS URL (for example: https://your-school.isams.cloud   )

Step 1: Generate an OAuth 2.0 Client Secret in iSAMS

1. Access API Services Manager

  1. Log in to iSAMS as an administrator.
  2. Navigate to Control Panel.
  3. Select API Services Manager.

2. Locate Your Batch API Key

  1. Select Manage Batch API Keys.
  2. Locate the Batch API Key that will be used for the SchoolCloud integration.

Note: If you do not already have a suitable Batch API Key, create one and ensure it has access to the required data areas.

3. Generate the Client Secret

  1. Click the gold key icon next to the relevant Batch API Key.
  2. When prompted to generate a new OAuth secret, select Yes.
  3. iSAMS will display:
    • Client ID
    • Client Secret
  4. Copy and securely store both values.

Important: The Client Secret may only be displayed once. Ensure you save it before closing the window.


Step 2: Configure the Connection in Parents' Meetings

1. Access Data Import Source

  1. Log in to Parents' Meetings using an administrator account.
  2. Navigate to:

Settings → Data Import Source

  1. If iSAMS is not already set as your MIS provider, contact SchoolCloud support.

2. Configure OAuth Authentication

  1. Open the data import source settings.
  2. Complete the fields below:
Setting Value
iSAMS Web Address Your school's iSAMS URL
iSAMS API Key API Key generated in iSAMS (same as Client ID)
Client ID Client ID generated in iSAMS (same as API Key)
Client Secret Client Secret generated in iSAMS
  1. Select Save.

Step 3: Run a Sync

⚠️ Important: We strongly advise against running a sync while an event  is open and accepting bookings.

During a sync, Parents' Meetings compares its data with your MIS. If any student, parent, staff member, or teaching relationship no longer meets the sync criteria, it may be removed from the event, even if it has synced previously.

This can affect existing bookings. To minimise disruption, only run MIS syncs outside active booking periods wherever possible. If a sync is required during a live event, carefully consider the potential impact before proceeding.

Once the connection has been successfully configured:

  1. Navigate to:

Settings → Data  → Run a New Sync

  1. Run a sync.
  2. Allow the sync to complete.
  3. Verify that staff, student and parent data has imported successfully.

Step 4: Verify the Integration

Check the following:

✅ Connection shows as active

✅ No authentication errors are displayed

✅ Student records have imported

✅ Parent records have imported

✅ Staff records have imported

✅ Recent changes in iSAMS are reflected within Parents' Meetings


Troubleshooting

Invalid Client ID or Client Secret

  • Verify both values have been copied correctly.
  • Generate a new Client Secret in iSAMS if required.
  • Update the credentials in Parents' Meetings and save again.

Authentication Failed

  • Confirm OAuth 2.0 has been selected as the authentication method.
  • Verify the iSAMS URL is correct.
  • Ensure the API Key remains active within iSAMS.

Data Not Importing

  • Confirm the Batch API Key has sufficient permissions.
  • Check that relevant data areas are enabled for API access.
  • Review the sync logs for specific errors.

Connection Timeout

  • Check firewall, proxy or network restrictions.
  • Confirm that external applications are permitted to access the iSAMS API.

Important Considerations

If you have active event bookings, we recommend avoiding unnecessary sync during live booking windows.

Changes made within iSAMS may update records within Parents' Meetings when a sync is run. If you are unsure of the impact, consider performing the configuration outside active booking periods or contact SchoolCloud Support before proceeding.