The Fairing script can be dropped onto a page to start collecting response data immediately. Your Fairing API Key and a customer ID/account ID are the only required fields to get up and running. There are additional optional fields that can be sent to enhance other features within Fairing, but are not required to collect responses. If you are integrating Fairing using Google Tag Manager, see additional instructions here.

The snippet includes a default styling. If you want to override any of the default styling, reach out to the Fairing team.

Install Fairing on your site

Paste the script below just before the closing </body> tag and replace CUSTOMER_ID with whatever internal ID uniquely identifies a customer or account, e.g. email address. Fairing uses this ID to determine which questions a customer has answered and is available in exports to associate responses with your internal data.

<script>
  (function() {
    const API_KEY = "PUT API KEY HERE";
    const CUSTOMER_ID = "PUT YOUR CUSTOMER EMAIL OR USER ID HERE";
    const s = document.createElement("script");
    
    s.src = "https://sdk.fairing.co/sdk/1.0.0-beta/fairing-1.0.0-beta.js";
    s.type = "module";
    s.defer = true;
    s.onload = function() {
      window.Fairing = Fairing(API_KEY, CUSTOMER_ID);
      Fairing.nextQuestion();
    };

    document.head.appendChild(s);
  })();
</script>

After your page loads, the Fairing SDK will append a container element to the body element and initialize the Question Stream. If there is a question available for the customer it will be displayed – this depends on the Question Stream configuration.

❗️

All customers will see questions they haven't answered yet

By default, a question will display for all customers who haven't answered it yet. To target only specific customers–for example new customers–conditionally render the script tag above for only those customers.

Testing Fairing

Enable Test Mode

The Fairing SDK supports a test mode. In test mode, the Question Stream functions as it normally would, but views and responses are not stored in Analytics. This makes it easier to test the integration and styling without polluting your Fairing account with test data. In a production environment, it can be used to troubleshoot integration issues on your live site. Test mode can be enabled in two ways:

Pass a configuration option to the constructor

See the opts.config Object in Additional Configuration. If you pass the test_mode configuration option in the script, the SDK will initialize in test mode. This option is best for development and staging environments.

<script>
  
  ...
  const s = document.createElement("script");
    const opts = {
      config: {
        test_mode: true   // Enable test mode  
    }
  };

  s.src = "https://sdk.fairing.co/sdk/1.0.0-beta/fairing-1.0.0-beta.js";
  ...
  
</script>

Manually callenableTestMode anddisableTestMode

The Fairing instance exposes enableTestMode and disableTestMode functions. To manually enable or disable test mode, in the browser, open the Dev console and call Fairing.enableTestMode() or Fairing.disableTestMode(). These functions change the setting and reload the page to start the SDK in the desired mode.

You can view the Question Stream event stream in app with our Debugger to ensure everything is working properly.

Logging

To reduce log noise, the Fairing SDK does not log to the development console by default. To enable logging, call Fairing.enableLogging() from the development console. To disable logging, call Fairing.disableLogging().

Additional Configuration Options

The SDK can be configured with additional options. The options are passed as the third argument to the Fairing constructor (i.e. window.Faring = Faring(API_KEY, CUSTOMER_ID, opts)).

<script>
  ...
  const opts = {
    customer: {...},
    container: ...,
    conversion: {...},
    integrations: {...},
    config: {...}
  };
                                                  
  window.Faring = Faring(API_KEY, CUSTOMER_ID, opts);
  ...
</script>

The options object has the following properties.

The opts.customer Object

The customer object can be used to pass additional information about the customer or account to Fairing.

The opts.conversion Object

The conversionobject represents details of the conversion event associated with the customer or account. These details can be provided to enhance Fairing's reporting.

The opts.container Property

By default, Fairing will append a container element to the document's body and render questions inside the container. The container is styled as a full screen modal and will only display if there is a question for the customer. To render the Question Stream in a different container element, pass a DOM node as the container property of the optionsobject. If there is a question to display for the current customer, the SDK will add a fairing-container--is-active class to the element so that it's visibility can be controlled via CSS. Be sure to declare the container-type: size CSS property on the container element. Fairing's CSS uses container queries based on the container size for its responsive design.

Example

<!doctype html>
<html lang="en">
  <head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">

    <title>
      Fairing Test Page
    </title>

    <style>
      body {
        font-family: sans-serif;
      }
      
      /* Set the container-type property on the custom container
      #my_custom_container {
      	container-type: size;
      }
    </style>
  </head>
  <body>
    <!-- Add the custom container element to the DOM -->
    <div id="my_custom_container">
    </div>
    
    <script>
      (function() {
        const container = document.getElementById("my_custom_container");
        ...
        
        // Add the container as the value of the container property
        // on the options object
        const opts = {
          container: container
        };

        ...
        
        s.onload = function(e) {
          // Pass opts to the constructor to use the custom container
          window.Fairing = Fairing(API_KEY, CUSTOMER_ID, opts);
          Fairing.nextQuestion();
        };

        document.head.appendChild(s);
      })();
    </script>
  </body>
</html>

The opts.integrations Object

The Fairing SDK can be configured to push events to Google Analytics, Google Tag Manager, or Rockerbox when a question is viewed or a response is provided. To enable these integrations, set the integrations property to true.

<script>
  ...

  const opts = {
    integrations: {
      ga: true,          // Set to true to fire Google Analytics events  
      gtm: true,         // Set to true to fire Google Tag Manager events  
      rockerbox: true    // Set to true to fire Rockerbox events
    }
  }

  ...

  s.onload = function(e) {
    // Pass opts to the constructor to enable integrations
    window.Fairing = Fairing(API_KEY, CUSTOMER_ID, opts);
    Fairing.nextQuestion();
  };

</script>

The opts.config Object

<script>
  ...

  const opts = {
    config: {
      test_mode: true,                  // Enable test mode  
      dismissible: true,                // Allow question modal to be dismissed
      display_success_message: true     // Display thank you message
    }
  }

  ...

  s.onload = function(e) {
    // Pass opts to the constructor to use the config options
    window.Fairing = Fairing(API_KEY, CUSTOMER_ID, opts);
    Fairing.nextQuestion();
  };

</script>