Skip to main content
Add one script tag to your HTML <head>:
That’s the entire install. window.aptly is ready immediately after the tag.

Copy-paste starting point

This is a complete working app. Replace BOARD_ID with your config variable name and fill in the render logic.

Testing before your app is embedded in Aptly

Get a dev token from Settings → Profile → Developer Tools (your Aptly admin must grant you the Developer Tools permission first). Paste this block right after the SDK script tag. Remove it before you ship.
startEmulation verifies the token against the Aptly API and populates aptly.user, aptly.org, and aptly.config with real data — the same values your app will see when embedded. Tokens can be issued with up to 7-day expiry.
Note: When your app runs inside Aptly, the SDK ignores startEmulation entirely — the live postMessage context always takes priority.

What’s in window.aptly

For the full reference — all properties, config scoping rules, URL param testing — see the SDK Reference.

Next steps

  • Deploy to Replit — publish your app, then paste the URL into an Aptly board tab or dashboard panel
  • Declare config variables — add fields like BOARD_ID in the app store admin panel so users can configure them on install
  • UI actions — use aptly.openEmailComposer(), aptly.createCard(), aptly.createTask(), and other named methods to trigger actions in the parent Aptly window. Actions are gated by aptly.actions (admin-configured allowlist)
  • Full API referenceDelegate Tokens covers server-side token exchange, scopes, and advanced auth patterns