Events

Prev Next

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

Your title goes here
While Insider automatically triggers SDK events, the other event types need to be implemented by customers.

SDK events

Session events are automatically triggered based on user actions on the application and campaigns and do not require customer configuration.

EventHow does it work?
Mobile App OpenedTriggered when the app is opened
Session StartTriggered every time a session starts
Session Start From PushTriggered if a session starts upon a click on a push notification triggered from an app template. Test pushes do not trigger this event.
Push SessionTriggered if a session starts upon a click on a push notification. Test pushes do not trigger this event.
Push DeliveredTriggered when a push is delivered
App Push OpenedTriggered when an app push is opened
InApp SeenTriggered when an inApp is seen along with the inApp ID and variant ID information
Mobile Social Proof SeenTriggered when a social proof is seen

Page visit events

You should trigger the page visit events when a user visits the respective page type 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

public void visitHomePage()
fun visitHomePage()

Method Example

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.

ParameterData Type
taxonomyArray of string
Your title goes here
This event will be ignored if you pass any nil/null or empty parameter to this method.

Method Signature

public void visitListingPage(String[] taxonomy)
fun visitListingPage(String[] taxonomy)

Method Example

String[] taxonomy = {"taxonomy1", "taxonomy2", "taxonomy3"};
Insider.Instance.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.

ParameterData Type
productobject (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

public void visitProductDetailPage(InsiderProduct product)
fun visitProductDetailPage(InsiderProduct product)

Method Example

Insider.Instance.visitProductDetailPage(insiderExampleProduct);

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.

ParameterData Type
insiderProductArray 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

public void visitCartPage(InsiderProduct[] products)
fun visitCartPage(InsiderProduct[] products)

Method Example

Insider.Instance.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.

ParameterData Type
insiderProductArray 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

public void visitWishlistPage(InsiderProduct[] products)
fun visitWishlistPage(InsiderProduct[] products)

Method Example

Insider.Instance.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.

ParameterData Type
saleIDString
productObject (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

public void itemPurchased(String saleID, InsiderProduct product)
fun itemPurchased(String saleID, InsiderProduct product)

Method Example

Insider.Instance.itemPurchased("uniqueSaleID", insiderExampleProduct);

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

public void signUpConfirmation()
fun signUpConfirmation()

Method Example

Insider.Instance.signUpConfirmation();

Cart events

You should trigger the cart events when a user takes the action for the respective type of cart moves 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.

ParameterData Type
productObject (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

public void itemAddedToCart(InsiderProduct product)
fun itemAddedToCart(InsiderProduct product)

Method Example

Insider.itemAddedToCart(with: insiderExampleProduct)

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.

ParameterData Type
productIDString
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

public void itemRemovedFromCart(String productID)
fun itemRemovedFromCart(String productID)

Method Example

Insider.Instance.itemRemovedFromCart("productID");

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

public void cartCleared()
fun cartCleared()

Method Example

Insider.Instance.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.

ParameterData Type
productObject (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

public void itemAddedToWishlist(InsiderProduct product)
fun itemAddedToWishlist(InsiderProduct product)

Method Example

Insider.Instance.itemAddedToWishlist(insiderExampleProduct);

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.

ParameterData Type
productIDString
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

public void itemRemovedFromWishlist(String productID)
fun itemRemovedFromWishlist(String productID)

Method Example

Insider.Instance.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

public void wishlistCleared()
fun wishlistCleared()

Method Example

Insider.Instance.wishlistCleared();