Verify you have staging credentials
If you do not have credentials yet, complete
first steps first. Confirm you have your staging client ID and secret.You will need these credentials for the CLI and SDK.
Install the CLI
Initialize your project
Run the interactive The CLI guides you through setup:See Configuration for the full schema reference.
timeback init command in your project root:- Mode: Initialize a new app or import an existing one
- App name: Enter your application name
- Subjects: Select subjects your app covers
- Grade levels: Select grade levels
- Launch URL: Your app’s entry point
timeback.config.json file in your project:timeback.config.json
Push to Timeback
Push your configuration to staging:This creates or updates your courses in Timeback.Use
--dry-run to preview changes:Emit learning events
Start emitting learning events from your app using Custom Activities.
- SDK (recommended)
- Caliper API
This example shows the
single-session pattern. If your
activities span multiple sessions, see stateful
activities for the multi-session model
with server-side completion.
See SDK Overview for full documentation.
What to expect next
After completing these steps:- Verify events are flowing using Studio
- Complete the Level 1 checklist
- Submit evidence for review
- Receive feedback and production credentials upon approval
CLI: Credentials
Manage multiple credential sets
CLI: Resources
Push, pull, and sync courses
Custom Activities
Time tracking and completion metrics for your content
Integration levels
See Level 1 requirements in detail
Need help?
Join us on Discord
Get integration support from the Timeback team and other developers.