Getting started

You will need:

  1. Your App ID: eb965a8c-c171-4b77-98a5-706ffb298df2
  2. Access to your codebase

Installation

Paste the snippet below before the </body> tag on every pages of your website.

<aside> ❗

Tandem won't function properly unless you install it on every page of your website.

</aside>

<script>
  window.tandemSettings = {
    app_id: app_id, // IMPORTANT: Replace with your App ID
    environment: environment // Optional: Replace with the environment where it runs. Default to Production.
    language: language, // Optional: Replace with the language of the interface. Defaults to English.
    theme: theme, // Optional: Set the theme. Defaults to the system theme. 
    user: { 
	    id: user.id, 
	    name: user.name, // Optional: replace with the connected user name
	    email: user.email // Optional: replace with the connected user email
	    custom_properties: user.properties // Optional: object of custom properties
    }
  };
</script>
<script type="module" src="<https://widget.usetandem.ai>" defer></script>

Parameters

Name Comment
app_id
required Your App ID, shared with you by Tandem
environment
optional The environment of Tandem. Used to specify whether Tandem is running in a sandbox (testing) or production environment.
Accepted values: sandbox,production
Default: production
language
optional The language Tandem will run.
Accepted values: en, es, de, fr, it,pt
Default: en
theme
optional The theme of Tandem.
Accepted values: light, dark, system
Default: system
user The connected user, to personalize the experience and collect user metrics.
user.id the user’s ID
user.name
optional the user’s name
user.email
optional the user’s email
user.custom_properties
optional the user’s custom properties
Type: JavaScript object
Example:
{
country: “FR”,
zendesk_user_id: “XXXX”
}

Checking that Tandem is installed correctly

You should see successful requests (non-4XX/5XX response codes) made to https://api.usetandem.ai