Event Object

The Event object helps you create custom events and event parameters in different data types. This article explains how you can build events and parameters in various data types.

Build event

This method allows you to build your Insider event object.

Your title goes here

You need to call this method to trigger your event.

Method Signature

build()

Method Example

insiderExampleEvent.build();

Set tag event

This method returns a new chainable Insider event object in which you can add parameters.

your title goes here

Your event name should be lowercase and not include special characters, non-Latin characters, or spaces. Otherwise, this event will be ignored. You can use underscores.

Parameter	Data Type
eventName	String

Method Signature

tagEvent(eventName: string): Event;

Method Example

// You can create an event without parameters and call the build method;
const event = window.Insider.tagEvent("event_name").build();

your title goes here

If you do not call Insider's Build Event method at the end of the chaining, this method will not function.

Set string parameter

This method allows you to set the string parameter of your Insider event object.

your title goes here

Your parameter key should be lowercase and should not include any special character, non-Latin character or any space. Otherwise, this parameter will be ignored. You can use underscores.

Parameter	Data Type
key	String
value	String

Method Signature

addParameterWithString(key: string, value: string): Event;

Method Example

// You can create an event with parameters and call the build method
const event = window.Insider.tagEvent("event_name").addParameterWithString('string_parameter','parameter').build();

Your title goes here

If you do not call Insider's Build Event method at the end of the chaining, this method will not function.

Set integer parameter

This method allows you to set the integer parameter of your Insider event object.

your title goes here

Your parameter key should be lowercase and should not include any special character, non-Latin character or any space. Otherwise, this parameter will be ignored. You can use underscores.

Parameter	Data Type
key	String
value	Number

Method Signature

addParameterWithInt(key: string, value: number): Event;

Method Example

// You can create an event with parameters and call the build method
const event = window.Insider.tagEvent("event_name").addParameterWithInt('int_parameter', 10).build();

your title goes here

If you do not call Insider's Build Event method at the end of the chaining, this method will not function.

Set double parameter

This method allows you to set the double parameter of your Insider event object.

your title goes here

Your parameter key should be lowercase and should not include any special character, non-Latin character or any space. Otherwise, this parameter will be ignored. You can use underscores.

Parameter	Data Type
key	String
value	Double

Method Signature

addParameterWithDouble(key: string, value: number): Event;

Method Example

// You can create an event with parameters and call the build method
const event = window.Insider.tagEvent("event_name").addParameterWithDouble('double_parameter',10.5).build();

your title goes here

If you do not call Insider's Build Event method at the end of the chaining, this method will not function.

Set date parameter

This method allows you to set the date parameter of your Insider event object.

your title goes here

Your parameter key should be lowercase and should not include any special character, non-Latin character or any space. Otherwise, this parameter will be ignored. You can use underscores.

Parameter	Data Type
key	String
value	Date

Method Signature

addParameterWithDate(key: string, value: Date()): Event;

Method Example

// You can create an event with parameters and call the build method
const event = window.Insider.tagEvent("event_name").addParameterWithDate('date_parameter', new Date())
.build();

your title goes here

If you do not call Insider's Build Event method at the end of the chaining, this method will not function.

Set array of string parameter

This method allows you to set the array of string parameter of your Insider event object.

your title goes here

Your parameter key should be lowercase and should not include any special character, non-Latin character or any space. Otherwise, this parameter will be ignored. You can use underscores.

your title goes here

You can call this method only with an array of string. Otherwise this parameter will be ignored.

Parameter	Data Type
key	String
value	Array (of string)

Method Signature

addParameterWithStringArray(key: string, value: Array<string>): Event

Method Example

const stringArray = ['value1', 'value2', 'value3'];
window.Insider.tagEvent('eventName')
         .addParameterWithStringArray('key', stringArray)
         .build();

your title goes here

If you do not call Insider's Build Event method at the end of the chaining, this method will not function.

Set array of number parameter

This method allows you to set the array of number parameter of your Insider event object.

your title goes here

Your parameter key should be only numbers. Otherwise, this parameter will be ignored.

your title goes here

You can call this method only with an array of number. Otherwise this parameter will be ignored.

Parameter	Data Type
key	Number
value	Array (of number)

Method Signature

addParameterWithNumericArray(key: string, value: Array<number>): Event

Method Example

const numberArray = [5, 3.14, 100];
window.Insider.tagEvent('eventName')
         .addParameterWithNumericArray('key', numberArray)
         .build();

your title goes here

If you do not call Insider's Build Event method at the end of the chaining, this method will not function.

Set boolean parameter

This method allows you to set the boolean parameter of your Insider event object.

your title goes here

Your parameter key should be lowercase and should not include any special character, non-Latin character or any space. Otherwise, this parameter will be ignored. You can use underscores.

Parameter	Data Type
key	String
value	Boolean

Method Signature

addParameterWithBoolean(key: string, value: boolean): Event;

Method Example

// You can create an event with parameters and call the build method
const event = window.Insider.tagEvent("event_name").addParameterWithBoolean('boolean_parameter', true).build();

your title goes here

If you do not call Insider's Build Event method at the end of the chaining, this method will not function.