Documentation Index
Fetch the complete documentation index at: https://docs.getaptly.com/llms.txt
Use this file to discover all available pages before exploring further.
Quick start
Add one script tag to your HTML<head>:
window.aptly is ready:
aptly.* properties and methods, see the SDK Reference.
Enable the SDK for your app
Open the board view settings for the tab that contains your app (or the dashboard panel), and toggle on Needs Aptly Context. This tells Aptly to deliver a delegate token and context to your app on each load.Config variables
Config variables let users configure your app with friendly pickers — board selectors, text fields, toggles — rather than pasting raw IDs. Admins declare them in the app store admin panel; users fill them in during install.aptly.config is the fully merged configuration for the current context. If the app supports board-level or user-level config, Aptly handles the merge before delivering context — your code always reads the same flat object. See Config scoping for how merge priority works.
Testing outside Aptly
When you’re building in Replit preview, running locally, or developing before the app is embedded, you need to simulate the context Aptly would deliver. Three options:Option A — startEmulation with a GA-issued dev token (recommended)
An Aptly admin generates a long-lived developer token in Global Admin → [Company] → Dev Tokens. Paste it into your app:
startEmulation verifies the token against the Aptly API to get real user and org identity, then populates window.aptly exactly as if Aptly had delivered the context via postMessage — same scopes, same user. Tokens can be issued with up to 7-day expiry so you won’t need to regenerate constantly.
Option B — window.APTLY_DEV block
Set values directly — useful for mocking specific config without a token:
Option C — URL params
When running inside Aptly (embedded iframe), the SDK ignores all dev options — the real postMessage context always takes priority.
UI operations
aptly.ui lets your app trigger actions in the parent Aptly window. All methods post a message that Aptly intercepts and handles. They are no-ops (with a console warning) when the app runs outside Aptly.
Examples
Each option below shows exactly where to place the dev-testing code relative to the SDK script tag. Theinit() function and app body are the same in all three — only the testing shim changes.
Option A — startEmulation (recommended)
Get a long-lived dev token from Global Admin → [Company] → Dev Tokens, then call startEmulation after the SDK loads. Remove the emulation block before deploying.
Option B — window.APTLY_DEV block
Set the dev block before the SDK tag so the SDK picks it up on load. Remove before deploy.
Option C — URL params
No code changes needed. Append params to the URL when opening your app. Nothing to remove before deploy.Next steps
- SDK Reference — full
window.aptlyAPI, config scoping, URL params - Delegate Tokens — raw token exchange API for server-side integrations and AI agents