Events

Below, you can see a list of default mobile events along with their method signatures and examples:

Your title goes here

While SDK events are automatically triggered by Insider, the other event types need to be implemented via their methods by partners.

SDK events

Session events are automatically triggered based on user actions on the application and campaigns and do not require any configuration from the customer's end.

Event	How does it work?
Mobile App Opened	Triggered when the app is opened
Session Start	Triggered every time a session starts
Session Start From Push	Triggered if a session starts upon a click on a push notification. Test pushes do not trigger this event.
Push Session	Triggered if a session starts upon a click on a push notification. Test pushes do not trigger this event.
Push Delivered	Triggered when a push is delivered
App Push Opened	Triggered when an app push is opened
InApp Seen	Triggered when an inApp is seen along with the inApp ID and variant ID information
Mobile Social Proof Seen	Triggered when a social proof is seen

Page visit events

You should trigger the page visit events when a user visits the respective type of page in the application. The default page visit events include the Homepage View, Listing Page View, Product Detail Page View, Cart Page View, and Confirmation Page View. See below for their method signatures and examples.

Your title goes here

If you want to trigger any event for any other type of page (e.g. test drive form page, discounts page, etc.), you should define a custom event on the Test Lab.

Homepage View

This method allows you to tag the visits on your homepage as an event. You can call this method each time a user visits your homepage.

Method Signature

visitHomePage(): void;

Method Example

window.Insider.visitHomePage();

Listing Page View

This method allows you to tag the visits on your listing page as an event. You can call this method each time a user visits your listing page along with the following event parameters: taxonomy, type, referrer, key, show_on_segment, is_pii, device_type, url, and source.

Parameter	Data Type
taxonomy	Array of string

Your title goes here

If you pass any nil/null or empty parameter to this method, this event will be ignored.

Method Signature

visitListingPage(taxonomy: object): void;

Method Example

const taxonomy = ['taxonomy1', 'taxonomy2', 'taxonomy3'];

window.Insider.visitListingPage(taxonomy);

Product Detail Page View

This method allows you to tag the visits on your product page as an event. You can call this method each time a user visits your product page along with the following event parameters: product ID, name, taxonomy, imageURL, price, and currency.

This event is required for the Social Proof method.

Parameter	Data Type
product	object (Insider product object)

Your title goes here

This event requires the Insider product object to be integrated beforehand along with its product ID, name, taxonomy, image URL, price, and currency attributes.

Method Signature

visitProductDetailPage(product: object): void;

Method Example

var product = window.Insider.createNewProduct('product_id',
        'Apple',
        taxonomy,
        'imageURL',
        1000.5,
        'currency');

window.Insider.visitProductDetailPage(product);

Cart Page View

This method allows you to tag the visits on your cart page as an event. You can call this method each time a user visits your cart page along with the following event parameters: product ID, name, taxonomy, imageURL, price, and currency.

Parameter	Data Type
insiderProduct	Array of Insider product object

Your title goes here

This event requires the Insider product object to be integrated beforehand along with its product ID, name, taxonomy, image URL, price, and currency attributes.

Method Signature

visitCartPage(products: object): void;

Method Example

window.Insider.visitCartPage(insiderExampleProducts);

Wishlist Page View

This method allows you to tag the visits on your wishlist page as an event. You can call this method each time a user visits your wishlist page along with the following event parameters: product ID, name, taxonomy, imageURL, price, and currency.

Parameter	Data Type
insiderProduct	Array of Insider product object

Your title goes here

This event requires the Insider product object to be integrated beforehand along with its product ID, name, taxonomy, image URL, price, and currency attributes.

Method Signature

function visitWishlistPage(products: object[]): void

Method Example

window.Insider.visitWishlistPage(insiderExampleProducts);

Confirmation Page View (Purchase)

This method allows you to tag the visits on your confirmation page as an event. You can call this method each time a user makes a purchase along with the following event parameters: product ID, name, taxonomy, imageURL, price, and currency.

This event is required for the Track Revenue method.

Parameter	Data Type
saleID	String
product	Object (Insider product object)

Your title goes here

Make sure to call this event only on successful transactions that are completed with any payment method.

Your title goes here

This event requires the Insider product object to be integrated beforehand along with its product ID, name, taxonomy, image URL, price, and currency attributes.

Method Signature

itemPurchased(uniqueSaleID: string, product: object): void;

Method Example

var product = window.Insider.createNewProduct('product_id',
        'Apple',
        taxonomy,
        'imageURL',
        1000.5,
        'currency');

await window.Insider.itemPurchased('unique_sale_id', product);

Sign Up Confirmation

This method allows you to tag the visits on your sign up confirmation page as an event. You can call this method each time a user signs up to your application.

Method Signature

signUpConfirmation(): void;

Method Example

window.Insider.signUpConfirmation();

Cart events

You should trigger the page visit events when a user visits the respective type of page in the application. The default cart events include the Item Added to Cart, Item Removed from Cart, and Cart Cleared. See below for their method signatures and examples.

Your title goes here

If you want to trigger any other cart-related event, you should define a custom event on the Test Lab.

Item Added to Cart (Add to Cart)

You can call this method whenever a user adds a product (Insider product object) to their cart along with the following event parameters: product ID, name, taxonomy, imageURL, price, and currency.

This event is required for the Cart Reminder method.

Parameter	Data Type
product	Object (Insider product object)

Your title goes here

This event requires the Insider product object to be integrated beforehand along with its product ID, name, taxonomy, image URL, price, and currency attributes.

Method Signature

itemAddedToCart(product: object): void;

Method Example

var product = window.Insider.createNewProduct('product_id',
        'Apple',
        taxonomy,
        'imageURL',
        1000.5,
        'currency');
const itemAC = window.Insider.itemAddedToCart(product);

Item Removed from Cart

You can call this method whenever a user removes a product (Insider product object) from their cart along with the following event parameters: product ID, name, taxonomy, imageURL, price, and currency.

This event is required for the Cart Reminder method.

Parameter	Data Type
productID	String

Your title goes here

This event requires the Insider product object to be integrated beforehand along with its product ID, name, taxonomy, image URL, price, and currency attributes.

Method Signature

itemRemovedFromCart(productID: object): void;

Method Example

const itemR = window.Insider.itemRemovedFromCart('product_id');

Cart Cleared

You can call this method whenever a user removes all products from their cart or when the last Insider product object is removed from the cart.

This event is required for the Cart Reminder method.

Your title goes here

Make sure to consider all cases and methods a user can empty their cart.

Method Signature

cartCleared(): void;

Method Example

window.Insider.cartCleared();

Wishlist events

You should trigger the wishlist events when a user takes the action for the respective type of wishlist moves in the application. The default wishlist events include the Item Added to Wishlist, Item Removed from Wishlist, and Wishlist Cleared. See below for their method signatures and examples.

Your title goes here

If you want to trigger any other wishlist-related event, you should define a custom event on the Test Lab.

Item Added to Wishlist (Add to Wishlist)

You can call this method whenever a user adds a product (Insider product object) to their wishlist along with the following event parameters: product ID, name, taxonomy, imageURL, price, and currency.

Parameter	Data Type
product	Object (Insider product object)

Your title goes here

This event requires the Insider product object to be integrated beforehand along with its product ID, name, taxonomy, image URL, price, and currency attributes.

Method Signature

function itemAddedToWishlist(product: object): void

Method Example

window.Insider.itemAddedToWishlist(product);

Item Removed from Wishlist

You can call this method whenever a user removes a product (Insider product object) from their wishlist along with the following event parameters: product ID, name, taxonomy, imageURL, price, and currency.

Parameter	Data Type
productID	String

Your title goes here

This event requires the Insider product object to be integrated beforehand along with its product ID, name, taxonomy, image URL, price, and currency attributes.

Method Signature

function itemRemovedFromWishlist(productID: string): void

Method Example

window.Insider.itemRemovedFromWishlist(productID);

Wishlist Cleared

You can call this method whenever a user removes all products from their wishlist or when the last Insider product object is removed from the wishlist.

Your title goes here

Make sure to consider all cases and methods a user can empty their wishlist.

Method Signature

function wishlistCleared(): void

Method Example

window.Insider.wishlistCleared();