Technical Documentation

Integration Guides

API-first, with resilient jobs and data quality checks. Start here.

Quick Start

Get started in four steps

Follow this guided path to establish your first integration

1

Provision sandbox; configure SSO & roles

Set up your sandbox environment with single sign-on authentication and define role-based access controls for your team.

  • Create sandbox instance
  • Configure SAML/OAuth SSO
  • Assign user roles and permissions
2

Load identity + enrollments; validate counts

Import student and enrollment data from your SIS, then verify data quality with automated count validation.

  • Import student records
  • Load enrollment data
  • Run validation checks
3

Enable LMS events; verify signals

Connect your learning management system to capture activity events and confirm signal detection is working properly.

  • Configure LMS webhooks
  • Enable activity tracking
  • Test signal detection
4

Connect CRM sync; approve note templates

Integrate with your CRM system to sync student interactions and review communication templates before going live.

  • Set up CRM connection
  • Configure sync schedules
  • Review and approve templates
Security Best Practices

Security tips

Essential security measures to protect your integration

Use private networking / IP allowlists

Restrict access to your integration endpoints using private networks or IP allowlists to minimize exposure.

  • Configure VPN or private peering
  • Maintain IP allowlist registry
  • Monitor access logs

Rotate credentials and webhook secrets

Regularly rotate API keys, passwords, and webhook secrets to reduce the risk of compromised credentials.

  • Set rotation schedules (90 days)
  • Use secrets management tools
  • Document rotation procedures

Enable audit export and retention policies

Maintain comprehensive audit trails and establish retention policies to meet compliance requirements.

  • Enable comprehensive logging
  • Set retention periods (7 years)
  • Schedule regular exports

Additional integration resources

Explore more technical documentation and guides

API Documentation

Complete API reference with endpoints, parameters, and examples.

CDM Integration Guide

Detailed guide for SIS, LMS, and CRM integrations with monitoring tips.

Best Practices

Implementation best practices and common pitfalls to avoid.

Need help with your integration?

Our technical team is ready to assist you with implementation and troubleshooting.