JustOneCX Docs

Appearance

Quickstart ​

Get a tour showing on your site in about five minutes.

1. Get your public key ​

  1. Sign in at app.justonecx.qd.je and open your workspace.
  2. Go to Settings → Developers.
  3. Copy the public key. It starts with pk_.

2. Allow your site ​

In Settings → Developers → Domains & CORS, add the origin of your site, for example https://www.example.com. For local work, add http://localhost:3000 (or your dev port). See Allowed origins.

3. Add the SDK ​

Paste this before the closing </body> tag of every page, with your own key:

html
<script
  src="https://app.justonecx.qd.je/sdk/justonecx-sdk.global.js"
  data-public-key="pk_your_workspace_key"
  data-api-url="https://api.justonecx.qd.je"
></script>

The script starts itself. There is nothing else to write.

Using React, Vue, Angular or another framework? See Frameworks. Prefer npm? See npm package.

4. Publish something ​

  1. In the dashboard open Tours and create a tour.
  2. Add a step and pick the element it should point at.
  3. Set the tour to Published.

5. Check it works ​

Open your site in a new browser window. The tour starts. If it does not, open Troubleshooting.

6. Tell us who the user is (recommended) ​

After a user signs in, call identify so you can target by plan or role:

js
window.JustOneCX.identify("user-42", { plan: "growth", role: "admin" });

When the user signs out, call reset:

js
window.JustOneCX.reset();

Before you go live, turn on identity verification.

Next steps ​

JustOneCX

SDK is MIT licensed.