Skip to main content

Custom Integration ⚙️

Overview

Custom integrations on Hischool are services that use the Hischool APIs to extend the functionality of Hischool.

By building a custom integration app, you can keep user information in sync with an identity service, automate student and teacher registration , or automate posting to school announcement based on activity in another service.

tip

Custom integrations are suitable for in-house development for your school (or bespoke development for the sole use of a single Hischool customer).

If you have a different purpose, e.g., offering a SaaS or PaaS integration to multiple Hischool customers, you should use Third Party Apps instead.

Do:

  • ✅ Use custom integrations to make Hischool a safer and more useful place to collaborate within your school

  • ✅ Use custom integrations for bespoke development for the sole use of a single Hischool customer

  • ✅ Remain compliant with Hischool's Platform Policies

Do not:

  • ❌ Use Custom Integrations to offer a service that you host and operate on behalf of other Hischool customers

  • ❌ Use Custom Integrations to attempt to bypass Hischool's app and security reviews

Creating an integration

Hischool APIs are openly available APIs which can be called by any developer that knows how to call REST-based APIs. Access to these APIs is controlled by apps, with specific permissions and protected by access tokens.

Learn more →

Grant Permissions

As a School admin, you can control the capabilities offered to each integration by creating apps and granting them specific permissions. Each app can be named to reflect the service it enables. Apps come with unique access tokens and permissions to control what information is allowed to be read or written by that app.

Learn more →

Access to Hischool APIs

The REST API for Hischool is a programmatic way to get data in and out of Hischool. It's a low-level HTTP-based API that you can use to query data about resources in a Hischool APIs.

Learn more →

Delete Integration

You can delete the integration. This action is not reversible and will delete the integration and its associated content.

Learn more →

Use Cases

As a School admin, you can control the capabilities offered to each integration by creating apps and granting them specific permissions. Each app can be named to reflect the service it enables. Apps come with unique access tokens and permissions to control what information is allowed to be read or written by that app.

Learn more →