Quickstart

Step 1 · Sign up and get your site key

When you create your Jourvex account, your first site is created automatically and a unique site key is generated for it.

The site key tells Jourvex which workspace incoming journeys belong to.

You can find your site key in: Dashboard → Settings → Installation

Step 2 · Install Jourvex

Add the Jourvex runtime to your website using a single script tag. Paste this before the closing </head> tag on every page you want coverage on.

<script
  defer
  src="https://edge.jourvex.com/jvx.js"
  data-site-key="YOUR_SITE_KEY">
</script>

First-party delivery

First-party proxy coverage is built in. All request from jvx.js route through edge.jourvex.com - a Jourvex-owned edge domain - before reaching the backend. No DNS setup required on your end.

Google Tag Manager

If your site uses Google Tag Manager, install Jourvex as a Custom HTML tag firing on all pages.

<script
  defer
  src="https://edge.jourvex.com/jvx.js"
  data-site-key="YOUR_SITE_KEY">
</script>

Next.js

Add the script inside your root layout or custom document file.

import Script from "next/script";

<Script
  src="https://edge.jourvex.com/jvx.js"
  data-site-key="YOUR_SITE_KEY"
  strategy="afterInteractive"
/>

Remix

Add the runtime inside your root document before the closing </body> tag.

<script
  defer
  src="https://edge.jourvex.com/jvx.js"
  data-site-key="YOUR_SITE_KEY">
</script>

SvelteKit

Add the runtime inside your root HTML template.

<script
  defer
  src="https://edge.jourvex.com/jvx.js"
  data-site-key="YOUR_SITE_KEY">
</script>

Step 3 · Verify installation

Open your website in a new tab and navigate through several pages.

Jourvex should begin capturing visitor activity automatically. Your first journeys should appear in the dashboard within a few minutes.

Debug mode

To enable debug mode locally:

<script
  defer
  src="https://edge.jourvex.com/jvx.js?debug=true"
  data-site-key="YOUR_SITE_KEY">
</script>

Optional · Queue stub

If you plan to use the State API before Jourvex finishes loading, add the queue stub before the runtime script.

<script>
window.jourvex = window.jourvex || {
  _queue: [],
  on: function(event, cb) {
    this._queue.push({ event, cb });
  }
};
</script>

<script
  defer
  src="https://edge.jourvex.com/jvx.js"
  data-site-key="YOUR_SITE_KEY">
</script>

What Jourvex captures automatically

Jourvex automatically captures evaluator journey signals with no manual event mapping required.

Common issues

Next steps