Events

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

• SDK Events
• Page Visit Events
• Cart Events
• Wishlist Events

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.

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.

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();

visitHomePage(customParameters?: CustomParameters)

You can call this method each time a user visits your homepage, optionally passing custom parameters.

Method signature

visitHomePage(customParameters?: CustomParameters): void;

Method example

const customParameters = {
    source: 'deeplink',
    campaign: 'spring_sale'
};

window.Insider.visitHomePage(customParameters);

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.

Method Signature

visitListingPage(taxonomy: object): void;

Method Example

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

window.Insider.visitListingPage(taxonomy);

visitListingPage(taxonomy: Array<string>, customParameters?: CustomParameters)

You can call this method each time a user visits your listing page, along with taxonomy and optional custom parameters.

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

Method signature

visitListingPage(taxonomy: Array<string>, customParameters?: CustomParameters): void;

Method example

const taxonomy = ['taxonomy1', 'taxonomy2', 'taxonomy3'];
const customParameters = {
    sort_type: 'price_asc',
    filter_count: 3
};

window.Insider.visitListingPage(taxonomy, customParameters);

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.

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);

visitProductDetailPage(product: object, customParameters?: CustomParameters)

You can call this method each time a user visits your product page with the Insider product object and optional custom parameters.

Method signature

visitProductDetailPage(product: object, customParameters?: CustomParameters): void;

Method example

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

const customParameters = {
    referrer: 'recommendation_widget',
    position: 2
};

window.Insider.visitProductDetailPage(product, customParameters);

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 with the list of Insider product objects, an optional saleID, and optional custom parameters.

Method signatures

visitCartPage(products: Array<object>): void;
visitCartPage(products: Array<object>, customParameters: CustomParameters): void;
visitCartPage(products: Array<object>, saleID: string): void;
visitCartPage(products: Array<object>, saleID: string, customParameters: CustomParameters): void;

Method examples

// Only products
window.Insider.visitCartPage(insiderExampleProducts);

// Products + customParameters
window.Insider.visitCartPage(insiderExampleProducts, { cart_total: 499.90, item_count: 3 });

// Products + saleID
window.Insider.visitCartPage(insiderExampleProducts, 'cart_session_123');

// Products + saleID + customParameters
window.Insider.visitCartPage(insiderExampleProducts, 'cart_session_123', {
    cart_total: 499.90,
    coupon_applied: true
});

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.

Method Signature

function visitWishlistPage(products: object[]): void

Method Example

window.Insider.visitWishlistPage(insiderExampleProducts);

visitWishlistPage(products: Array<object>, customParameters?: CustomParameters)

You can call this method each time a user visits your wishlist page with the list of Insider product objects and optional custom parameters.

Method signature

visitWishlistPage(products: Array<object>, customParameters?: CustomParameters): void;

Method example

const customParameters = {
    item_count: 5,
    last_updated: new Date()
};

window.Insider.visitWishlistPage(insiderExampleProducts, customParameters);

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.

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);

itemPurchased(uniqueSaleID: string, product: object, customParameters?: CustomParameters)

You can call this method each time a user makes a purchase, along with the unique sale ID, Insider product object, and optional custom parameters.

Method signature

itemPurchased(uniqueSaleID: string, product: object, customParameters?: CustomParameters): void;

Method example

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

const customParameters = {
    payment_method: 'credit_card',
    discount_amount: 50.0,
    is_first_purchase: true,
    purchase_date: new Date()
};

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

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.

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.

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);

itemAddedToCart(product: object, customParameters?: CustomParameters)

You can call this method whenever a user adds a product (Insider product object) to their cart, along with optional custom parameters.

Method signature

itemAddedToCart(product: object, customParameters?: CustomParameters): void;

Method example

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

const customParameters = {
    quantity: 2,
    size: 'M',
    color: 'red'
};

window.Insider.itemAddedToCart(product, customParameters);

Item Removed from Cart

You can call this method whenever a user removes a product from their cart. An optional saleID and optional custom parameters may be supplied

This event is required for the Cart Reminder method.

Method Signatures

itemRemovedFromCart(productID: string): void;
itemRemovedFromCart(productID: string, customParameters: CustomParameters): void;
itemRemovedFromCart(productID: string, saleID: string): void;
itemRemovedFromCart(productID: string, saleID: string, customParameters: CustomParameters): void;

Method Examples

// Only productID
window.Insider.itemRemovedFromCart('product_id');

// productID + customParameters
window.Insider.itemRemovedFromCart('product_id', { reason: 'out_of_stock' });

// productID + saleID
window.Insider.itemRemovedFromCart('product_id', 'cart_session_123');

// productID + saleID + customParameters
window.Insider.itemRemovedFromCart('product_id', 'cart_session_123', {
    reason: 'user_removed',
    quantity: 1
});

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.

Method Signature

cartCleared(): void;

Method Example

window.Insider.cartCleared();

cartCleared(customParameters?: CustomParameters)

You can attach optional custom parameters to this method.

Method signature

cartCleared(customParameters?: CustomParameters): void;

Method example

const customParameters = {
    reason: 'user_cleared',
    cleared_at: new Date()
};

window.Insider.cartCleared(customParameters);

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.

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.

Method Signature

function itemAddedToWishlist(product: object): void

Method Example

window.Insider.itemAddedToWishlist(product);

itemAddedToWishlist(product: object, customParameters?: CustomParameters)

You can call this method whenever a user adds a product (Insider product object) to their wishlist, along with optional custom parameters.

Method signature

itemAddedToWishlist(product: object, customParameters?: CustomParameters): void;

Method example

const customParameters = {
    source: 'product_detail',
    is_gift: false
};

window.Insider.itemAddedToWishlist(product, customParameters);

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.

Method Signature

function itemRemovedFromWishlist(productID: string): void

Method Example

window.Insider.itemRemovedFromWishlist(productID);

itemRemovedFromWishlist(productID: string, customParameters?: CustomParameters)

You can call this method whenever a user removes a product from their wishlist, along with optional custom parameters.

Method signature

itemRemovedFromWishlist(productID: string, customParameters?: CustomParameters): void;

Method example

const customParameters = {
    reason: 'moved_to_cart'
};

window.Insider.itemRemovedFromWishlist('product_id', customParameters);

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.

Method Signature

function wishlistCleared(): void

Method Example

window.Insider.wishlistCleared();

wishlistCleared(customParameters?: CustomParameters)

You can attach optional custom parameters to this method.

Method signature

wishlistCleared(customParameters?: CustomParameters): void;

Method example

const customParameters = {
    reason: 'user_cleared',
    cleared_at: new Date()
};

window.Insider.wishlistCleared(customParameters);