Skip to Content
Docs

Know your users

Choose how much the chat knows about the people who write, from anonymous guests to verified users.

By default everyone who writes is a guest. There are three levels:

LevelWhat you doWhat it gives
GuestsNothingChat for anyone. History stays on the device they wrote from
Unverified detailsidentify({ id, name, email }), no server workThe form filled in for them, and a label for your team
Verified usersidentify({ token }), and set up Settings → IdentityHistory on every device, their organisation, nothing to type

A verified user is signed in with a token your install checks, in one of two ways:

  • Signed token: your server signs a short JWT with a key from your install. A few lines of server code.
  • Profile endpoint: the page hands over the access token your app already has, and the install asks your product's "who am I" address whose it is. No new code on your server.

When a guest logs in, what they wrote as a guest on that device becomes theirs: see From guest to user. Whatever the level, a page can pass context, such as the plan or order someone is looking at.

Identify users on every page

app.html
<script>
  Helpwren.init({ source: "web_app" });
  // A function, so a fresh token can be fetched if one expires.
  Helpwren.identify({ token: () => fetch("/api/support-token").then((r) => r.text()) });

  // When they log out:
  Helpwren.reset();
</script>

Call identify straight after init on every page where someone is logged in. A page that loads without it shows a guest's chat, even if a user was signed in there before, so someone who logs out of your product does not stay logged in to support. The identity event says whether signing in worked.