What the Endpoint device app actually does, and where the real docs live
Endpoint is a downloadable device-monitoring app for macOS: an end user enrolls a machine by scanning a QR code, and the app then reports telemetry — screenshots, running processes, application focus changes, browser URLs, activity and blacklisted-app violations — back to this server. The HTTP surface is deliberately small: POST /endpoint/register exchanges a scanned enrollment token for a per-device credential, and POST /endpoint/login does the same for username-and-password organizations. Everything after that happens over a WebSocket the app opens to /cable.
The reference documentation below is generated from the same markdown files this repository ships, so what it says is what the server does.
Every partner-facing doc, served as styled HTML and as raw markdown at stable URLs.
Browse /docs/partnersHow a partner enrolls end-user devices — API keys, QR enrollment, the endpoint.registered webhook, and the enrollment-state pull API.
Read the Partner API docWhat an enrolled device reports over the WebSocket, how each report is stored, and how to get it back out.
Read the telemetry docEndpoint also proctors online exams. Your platform owns the exam and the result; we verify who is sitting it, monitor the attempt through a Chrome extension, and report what we saw. The standard partner integration is LTI 1.3, with its own documentation set and its own privacy policy — the device app is not involved.
Overview, LTI 1.3, proctoring settings, webhooks and events — HTML and raw markdown at stable URLs.
Browse /docs/proctoringWhat we monitor, what a candidate goes through, what your platform gets back, and which integration path to read next.
Read the overviewWhat we collect from a candidate, who sees it, and how long we keep it.
Read the policy