Changelog

This page records partner-visible changes: operations in the published API Reference, documented behaviour in the published guides, and insight-type semantics. Internal changes with no external effect are not listed here.

2026.08.24.1

  • Webhooks guide: org.config.updated is now in the event catalog. It fires when an organization's config row set is written through PUT /rostering/1.0/orgs/{sourcedId}/config (any key write). Payload: { orgId }. Subscription routing follows the standard org-scope rule. Non-breaking.

2026.08.21.1

  • Registration guide: documents the awaiting_secret_claim sandbox status and its recovery path. When a sandbox client is provisioned but its secret was never surfaced, GET /applications/1.0/{appId}/credentials reports sandboxStatus: awaiting_secret_claim; call POST /applications/1.0/{appId}/credentials/rotate to receive a claim URL. Non-breaking.

2026.08.17.1

  • Insights API Reference: GET /insights/1.0/insight-groups is now published. It returns the registered insight groups with family, membership rule, and a count of types visible to the caller in each group. Non-breaking.

2026.08.11.1

  • Insights API Reference: GET /insights/1.0/catalog has been removed from the published surface. It returned locale-keyed message bundles for catalog-managed proctoring insights and was consumed at session start. Breaking for integrators that called it directly.

2026.08.03.1

  • Four insights endpoints are now in the API Reference: the type catalog (GET /insights/1.0/types), the enriched session list (GET /insights/1.0/sessions), the per-type student-facing message (GET /insights/1.0/catalog), and session enforcement state (GET /insights/1.0/sessions/{sessionId}/enforcement-state). Non-breaking.
  • The Level 4: Insights API guide now teaches the catalog endpoint rather than a fixed list of type slugs, and its property, category, and overview-level tables match what the API returns. Non-breaking.
  • The insight types the guide used to list are marked deprecated: they are being retired and will stop being populated. Pull the current list from the type catalog. Breaking for integrators that hard-coded those slugs.
  • The guide no longer lists types that are internal to TimeBack and were never returned to external callers. Non-breaking.