An Onboarding invitation represents a self-guided integration flow initiated by either a developer team (inviting a school district to connect) or a district team (requesting an application integration).
Supported onboarding modes:
- Developer to District: Developers invite district administrators to link their LMS or SIS.
- District to Vendor: School districts request integration access from an edtech application.
Properties
| Property | Type | Description |
|---|---|---|
id | UUID | Unique identifier for the onboarding invitation. |
created_date | Date | Date when the invitation was created. |
updated_date | Date | Date when the invitation was last updated. |
state | String | Status: pending, started, completed, or expired. |
application_id | UUID | ID of the application to be connected. |
source_id | UUID | ID of the source (for district-initiated invitations). |
automatic_approval | Boolean | Whether resulting integrations are approved automatically without manual review. |
redirect_uri | String | Post-onboarding redirection URL for administrators. |
expiration_date | Date | Optional expiration timestamp after which the link becomes invalid. |
JSON Example
{
"id": "c3600e5f-7da5-4820-9ca9-aa4a1e9793b3",
"created_date": "2026-07-01T14:00:00.000Z",
"updated_date": "2026-07-15T09:30:00.000Z",
"state": "pending",
"application_id": "035d6dd6-1569-47b2-8ed8-63435be58078",
"automatic_approval": false,
"redirect_uri": "https://acmelearning.com/app/onboarding-complete"
}