Touchpoint website integrations (developer version)

Integrate Touchpoint with your website(s) in order to deploy activities directly to your site and collect valuable insights from your broader audience. The integration is achieved by installing the Touchpoint code snippet in the header of your site.

• Each site you add will require its own code snippet.

  There is a one-to-one mapping between the domains you want to register and the code snippets associated with them. The steps below will be required for each new domain you add.

• Each integration requires a one-time setup.

  Once completed, Touchpoint recognizes every page that exists on the domain and you are not required to make additional code updates.

Once the integration is successfully implemented, the following information is collected from users and visitors:

• User Agent String: Shows the browser version, device make/model, and so on.
• Device ID on mobile devices
• OS type and version

None of this is personally identifiable information (PII). This information is not stored in cookies.

Step 1: Indicate the root URL you want to integrate

1. Click Sites & Integrations > Add New Site.
2. Type the root URL of the site.
   Root URL: https://www.rooturl.com
3. Name the site for internal reference.
4. Click Continue.

Step 2: Generate the unique JavaScript code snippet

The code snippet is unique per domain.

Why is a unique JavaScript Code snippet required per domain?

Touchpoint allowlists the registered domain for security purposes to allow it to make requests to our back-end servers. Requests made from a domain that has not been registered are rejected.

1. Click Do it yourself.
2. Select Multi-Page App or Single Page App.
3. Optional: Click Enable Visitor Attributes.
   Enable this option if you plan to use targeting with visitor attributes.
4. Click Copy Code.

   App Type	Description
   Multi Page App	There is one code snippet that has to be inserted into the HTML template below <header>.
   Single Page App	There are two code snippets: One that has to be inserted in the HTML template below <header>, and one that has to be inserted into the page users see after they authenticate into the website.

Step 3 (optional): Send visitor information to Touchpoint

Add data points to the visitor payload and user attributes so that you can send facts about your visitors, taken from your site's data, directly into Touchpoint.

• Visitor payload can give you better insight into your broader audience's behavior and experiences. This augments the story your data tells and helps you understand more about the who behind the what and the why.
• User attributes can help you reach the specific audience segments you want to hear from most. Present the right questions to the right people while reducing the burden on other site visitors.

Click here to learn more about visitor payload.

Click here to learn more about user attributes.

Step 4: Place the code snippet in the <header> of the site

For the fastest loading experience of the intercept (that is, the activity), we recommend including the code snippet in the header of the site. This ensures that the Touchpoint script starts downloading as soon as possible. However, the snippet can go somewhere else if the <header> is not accessible or available for the code snippet to be added.

Performance

• Loading the script does not block the loading of the rest of your site as it uses asynchronous loading. Touchpoint respects the content of the site it is hosted on and allows the site to load first before a call is made.
• Touchpoint runs everything that is time/resource consuming in a separate web worker.
• Touchpoint can handle over 180 starts per second.

Step 5: Validate the integration

• After the code snippet has been integrated, visit your site and verify that the Touchpoint GetWidgets endpoint call is successful.
• Click Sites & Integrations > Integrated Sites, and then click the site listing.
  Confirm in the UI that the site has been integrated and is active.
• Ensure that the visitor payload is a properly formed JavaScript object and there are no syntax errors in the modifications to the snippet (for example no spaces, named variables exist in your site).
• Type Touchpoint.version in the console tab of dev tools and see if there is an output.
  If the output looks like this, the snippet has been registered properly.
• Verify that the UserAttributes endpoint call is successful.

  Example of an error if something isn't correctly defined: