Install Seeka via iframe
This installation method is not recommended due to incompatibility with the Express Setup tool
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.
Software vendors
If you are a software vendor installing Seeka on behalf of your customers, declare your software name and version via the last two parameters of SeekaFrameInit. Seeka records your integration as the client iframe/<your software name>, which allows activity to be matched back to your software and your integration to show as connected 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
false,
// Enables logging to javascript console. either information, warning, error, verbose - set to '' in production
'',
// Host
'https://sdk.seeka.services',
+ // Client name - the name of your software
+ '<your software name>',
+ // Client version - the version of your software build or integration
+ '<your software version>'
).init();| Parameter | Description |
|---|---|
<your software name> | Name of your software, for example ticketsaurus. Maximum 24 characters. Seeka records the client as iframe/<your software name>. |
<your software version> | Version of your software build or the version of your integration, for example 1.2.0. Maximum 16 characters. Defaults to 1.0.0 when a client name is provided. |
If you are installing Seeka on your own site rather than on behalf of software customers, omit both parameters.
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();