Queek docs

Queek apps

Build an app merchants install from their dashboard. Embedded pages, signed webhooks, scoped Merchant API access and storefront blocks, running on your own infrastructure.

A Queek app is a web application a merchant opens from their dashboard. You host it. Queek handles the install lifecycle, hands you signed credentials, and gives the app scoped access to the Merchant API.

An app can:

  • serve an embedded page inside the merchant dashboard;
  • accept signed install, uninstall and settings handoffs;
  • subscribe to webhooks for orders, products, customers, stock and translations;
  • call the Merchant API with an installation token limited to the scopes the merchant granted;
  • add storefront blocks and serve read-only data to the storefront through a signed proxy;
  • add dashboard blocks, actions and print layouts to order and product pages.

Limits to know before you design

LimitDetail
ScopesAn installation can call only the Merchant API operations its granted scopes cover. App management, API keys, roles, users, employees and point of sale are never grantable.
Storefront proxyServes GET only.
ExtensionsTargets and counts are bounded: see the manifest reference.
CapabilitiesSome things apps cannot do yet, such as payment gateways, carrier rates or recurring billing, and a few that Queek deliberately does not offer. Check capabilities before you commit to a design.
ReviewEvery app is reviewed before it is listed publicly, and updates that add a sensitive capability are reviewed again. Plan a screencast: see App review and distribution.

The path from idea to listing

  1. Check capabilities. Confirm the platform supports your use case, and note any limit or workaround.
  2. Build an app. Scaffold, run on a dev store, host, deploy and submit.
  3. Configure the manifest. Scopes, webhook topics, extensions.
  4. Use the SDK. Install handlers, session verification, webhooks and the typed Merchant API client.
  5. Build the embedded page. The bridge messages, the handshake timings, frame sizing and where dialogs go.
  6. Get reviewed. Submit with a screencast, pass the automated checks and go live in the app store.

On this page