Install Seeka via iframe

Public Preview

Iframe is currently in public preview and as a result the way this feature is used may change over time.

Use with caution in production environments.

This installation method is not recommended. The Express event setup tool / Sidekick does not work with this installation method.

Installing the iframe

Install the below script tag on the line above the </head> tag in your site HTML.

The complete script tag that installs the iframe is specific to your Seeka account/brand and can be retrieved from your Seeka app. Once the tag has been installed in your HTML the SDK can be interacted with.

It is important that the tag be installed as high as possible in the <head> tag to ensure that the SDK is loaded as early as possible.

Interacting with the SDK

After the tag has been installed, the Browser SDK can be interacted with.

See the method reference for a list of available methods.

Example project

For a complete example, download this project and refer to the README.md file.

Testing

To enable streaming of events to Seeka's Server streamer, set the below value to true and then click the "View stream" button in the Seeka app.

...

window.Converge = new SeekaFrameInit(
    // Org id
    '',
    // Public key
    '',
    // Seeka brand/scope ID
    '',
+     // set to false in production - enables tracked events to end up in server diagnostic streamer inside seeka app
+     true,

    // Enables logging to javascript console. either information, warning, error, verbose - set to '' in production
    '',
    // Host
    ''
).init();

Iframe installation does not support the "browser streamer" and as such the browser console is the only method for debugging browser side.

To enable Seeka to log to the browsers console, change the value below.

...

window.Converge = new SeekaFrameInit(
    // Org id
    '',
    // Public key
    '',
    // Seeka brand/scope ID
    '',
    // set to false in production - enables tracked events to end up in server diagnostic streamer inside seeka app
    true,

+     // Enables logging to javascript console. either information, warning, error, verbose - set to '' in production
+     'information',

    // Host
    ''

).init();

Noteworthy

  • Immediately after the placement of the iframe tag or .init() line, the Converge.track and Converge.identity methods can be used.
  • Browser Hooks will be bubbled up from the iframe into the top window. These can be listened to by following the Hooks docs.
  • Iframe content is served via the CDN.