Connecting a school district to your application is the "go-live" moment for your integration. This guide outlines how to manage this process, the tools available to you in the Edlink Dashboard, and best practices for ensuring a smooth setup for your customers.
Types of Onboarding Links
Edlink provides three primary ways to initiate the connection process. You can find these options in the Edlink dashboard under the Onboardings tab.
Generic Integration Link
This is a static, permanent URL unique to your application (e.g., https://ed.link/integrate/abc-123).
- Best for: Adding to your public documentation, "Getting Started" emails, or a "Connect LMS" button in your app settings.
- Pros: Easy to distribute; never expires.
- Cons: Harder to track which specific district clicked it until they complete the process.
Unique Invitations
You can generate a one-time link for a specific district via the "Invite a School" button in the dashboard.
- Best for: Sales teams managing a specific deal pipeline.
- Pros: You know exactly who the link is for; you can set expiration dates; ensures the correct admin connects the data.
- Cons: Requires manual or automated generation for each customer.
Embedded Onboarding
Using the Edlink Widgets, you can render the onboarding flow directly inside your application via a modal.
- Best for: SaaS platforms wanting a seamless, white-labeled feel.
- Pros: User never leaves your site; you receive real-time events (success/failure) via JavaScript to update your UI immediately.
- Cons: Requires engineering implementation.
The District Admin Experience
Regardless of the link type used, the experience for the school administrator is relatively standardized and designed to be quick. For a prepared administrator, this process typically takes 5 to 15 minutes.
What they will do:
- Click the link and create a district Edlink account (or log in).
- Select their data source (e.g., Canvas, Google Classroom).
- Input their API credentials or authorize via OAuth 2.0 (depending on the provider).
- Run a validation check to ensure Edlink can access the required data.
- Confirm the integration.
There may be optional steps, such as attaching an SSO provider or configuring specific data mapping settings, but these are not typically required to complete the onboarding.
Finding the Right Administrator
The most common cause of onboarding failure is the wrong person attempting the integration.
- Who you need: The IT Director, LMS Administrator, or System Administrator.
- Who cannot do it: Teachers, Principals, or Curriculum Directors usually do not have the high-level API permissions required to connect an LMS or SIS.
Special Cases: App Store Integrations
Some providers—specifically Clever, ClassLink, and Eduplaces—function differently. These platforms act as "App Stores."
- The Process: Instead of sending an Edlink onboarding link, the district administrator usually logs into their Clever/ClassLink/Eduplaces dashboard, finds your application in the library, and clicks "Add" or "Connect."
- Edlink's Role: Edlink automatically detects this connection and creates the integration in your dashboard. Our system checks for new connections every 15 minutes, so please be patient after the administrator initiates the connection.
- Action Item: Direct these customers to add your app via their respective platform's portal rather than sending them an Edlink link.
Best Practices & Support
We strongly recommend that you do not send self-onboarding links to your first 5 customers.
Instead, try to get the district admin on a video call (Zoom/Google Meet) and walk them through the process live. This helps your team understand the flow, identify common friction points, and build confidence in the integration. Once your team is comfortable with the flow and answering common questions from admins, you can switch to a self-serve model where you simply email the link or embed it in your app.
Leveraging Your Client Success Manager
Your Edlink Client Success Manager (CSM) is a resource for your team.
- They can train your sales or support team on how to handle onboardings.
- For high-stakes or complex districts, you can invite your CSM to the onboarding call to provide technical assistance.
- If an admin gets stuck, your CSM can look at the specific logs and provide exact instructions to resolve the issue.