Developers

Developer Portal

APIs, webhooks, LTI, OneRoster, and app extensions.

API & schema

OpenAPI schema and interactive docs are available after login at your school subdomain.

Path: /api/schema/ui/

Available after login at your school subdomain (e.g. yourschool.runmycampus.com/api/schema/ui/).

Interop & readiness

Discovery and readiness endpoints for LTI 1.3, OneRoster, Ed‑Fi, and CEDS.

Webhooks documentation

App install lifecycle

Request install → approval → schema patch (if allowed) → register widgets → audit. Tied to MarketplaceApp and AppInstallation.

  1. Request install – School or admin requests an app from the marketplace.
  2. Approval – Admin approves; install_app(school, app) creates AppInstallation with status ACTIVE.
  3. Schema patch – If the app manifest specifies migrations_app or schema_patch_app and platform allows it, migrations run in the tenant context.
  4. Register widgets – Widget config from the app manifest is stored on the installation; portal surfaces widgets for active installations only.
  5. Audit – Every install, uninstall, and suspend is recorded in AppAuditLog with actor and payload.

App sandbox – Run third-party app previews in an iframe with CSP and sandbox restrictions.

SDK

Minimal client and auth helpers for API integration.

SDK & API reference – Auth, base URL, and endpoint summary.

RunMyCampus SDK (GitHub) – README and minimal module (e.g. auth helper or API client stub).