Miniwall Docs
Project setup

Project setup

What a developer needs from the dashboard to wire the SDK to a project - keys, allowed origins, placements and the install page.

The dashboard is where your team builds and publishes screens. You, as the developer, only need a few things from it. This section lists them. How to use the visual editor is not covered in these docs.

You needWhere to get itPage
A public key (pk_...)API keysAPI keys and allowed origins
Your site or app on the allow-list (if the project uses one)API keysAPI keys and allowed origins
A placement key, such as upgrade_buttonPlacementsPlacements
The package IDs your screen usesThe screen's plan cards, or Install SDKPackages and pricing
To know how views are countedPlansPlans and views

Projects

A project is one product or website. It has its own screens, placements, public keys, allowed origins, members, plan and view count. A public key works for exactly one project. Use one project per product, and a separate one for staging if you want separate numbers.

The Install SDK page

Install SDK in the dashboard builds a ready-to-paste snippet for one screen: pick the platform (Web, iOS, Android, React Native or Flutter) and how the screen opens (On button click or Automatic). Your public key, placement key and the screen's package IDs are filled in.

It also shows a status: Waiting for your site. until the SDK reports its first view, then Live. If it stays on waiting, see Troubleshooting.

The same snippets are in the SDK docs. Start from the Quickstart.

Roles

Each person has one role per project. Viewer reads everything. Editor builds and publishes screens and configures placements. Admin also creates and revokes API keys, manages allowed origins and people. Owner also controls ownership. If you are not an admin, ask one to create your key. A button that is disabled shows the reason in a tooltip.

On this page