Events

Below, you can see a list of the following 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

static visitHomePage()

Method Example

RNInsider.visitHomePage();

visitHomePage(customParameters?)

This method allows you to tag your Homepage as an event with custom parameters. You can call this method each time the user visits your HomePage. This method tracks the homepage visit event and includes any custom parameters you provide.

Return value: void

Method signature

// Without custom parameters
RNInsider.visitHomePage();

// With custom parameters
RNInsider.visitHomePage(customParameters);

static visitHomePage(customParameters?: CustomParameters): void;

Method example

const customParams = {
  source: "demo",
  campaign_id: "campaign_123",
  page_number: 1
};

RNInsider.visitHomePage(customParams);

Listing Page View

This method allows you to tag visits to your listing page as events. 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

static visitListingPage(taxonomy: Array<string>)

Method example

const taxonomy = ['taxonomy1', 'taxonomy2', 'taxonomy3'];
RNInsider.visitListingPage(taxonomy);

visitListingPage(taxonomy, customParameters?)

This method allows you to tag your Listing Page as an event with custom parameters. You can call this method each time the Listing Page is visited by the user. This method tracks the listing page visit event with the provided taxonomy and includes any custom parameters.

Return value: void

Method signatures

// Without custom parameters
RNInsider.visitListingPage(taxonomy);

// With custom parameters
RNInsider.visitListingPage(taxonomy, customParameters);

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

Method example

const taxonomy = ["Electronics", "Smartphones", "Samsung"];

const customParams = {
  page_number: 1,
  sort_by: "price",
  filter_applied: true
};

RNInsider.visitListingPage(taxonomy, customParams);

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.

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

static visitProductDetailPage(product: RNInsiderProduct)

Method example

RNInsider.visitProductDetailPage(insiderExampleProduct);

visitProductDetailPage(product, customParameters?)

This method allows you to tag your ProductDetailPage as an event with custom parameters. You can call this method each time the user visits your ProductDetailPage. This method tracks the product detail page visit event and includes any custom parameters you provide.

Return value: void

Method signatures

// Without custom parameters
RNInsider.visitProductDetailPage(product);

// With custom parameters
RNInsider.visitProductDetailPage(product, customParameters);

static visitProductDetailPage(product: RNInsiderProduct, customParameters?: CustomParameters): void;

Method example

const product = RNInsider.createNewProduct(
  "demo_product_123",
  "Demo Product",
  ["Electronics", "Smartphones"],
  "https://example.com/image.jpg",
  99.99,
  "USD"
);

const customParams = {
  source: "search",
  campaign_id: "campaign_123",
  recommendation_id: "rec_456"
};

RNInsider.visitProductDetailPage(product, customParams);

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, passing the following event parameters: product ID, name, taxonomy, imageURL, price, and currency.

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

static visitCartPage(products: Array<RNInsiderProduct>): void;

Method example

RNInsider.visitCartPage(insiderExampleProducts);

visitCartPage(products, saleID?, customParameters?)

This method allows you to tag your Cart Page as an event with a saleID and/or customParameters. You may now optionally pass a saleID and/or a customParameters object along with the required products array.

This event requires the Insider product object to be integrated beforehand, along with its product ID, name, taxonomy, image URL, price, and currency attributes. The second argument is resolved at runtime, the same way as in itemRemovedFromCart.

Method signatures

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

Method examples

// Basic call
RNInsider.visitCartPage(insiderExampleProducts);

// With custom parameters only
RNInsider.visitCartPage(insiderExampleProducts, {
  cart_total: 1250.75,
  item_count: 3,
});

// With saleID
RNInsider.visitCartPage(insiderExampleProducts, 'uniqueSaleID');

// With saleID and custom parameters
RNInsider.visitCartPage(insiderExampleProducts, 'uniqueSaleID', {
  cart_total: 1250.75,
  item_count: 3,
});

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.

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

static visitWishlistPage(products: Array<RNInsiderProduct>): void;

Method example

RNInsider.visitWishlistPage([insiderExampleProduct]);

visitWishlistPage(products, customParameters?)

This method allows you to tag your Wishlist as an event with custom parameters. You can call this method each time the user visits your Wishlist, passing the products on the page. This method tracks the wishlist visit event and includes any custom parameters you provide.

Return value: void

Method signatures

// Without custom parameters
RNInsider.visitWishlistPage(products);

// With custom parameters
RNInsider.visitWishlistPage(products, customParameters);

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

Method example

const product = RNInsider.createNewProduct(
  "demo_product_123",
  "Demo Product",
  ["Electronics", "Smartphones"],
  "https://example.com/image.jpg",
  99.99,
  "USD"
);

const products = [product];

const customParams = {
  wishlist_total_items: 5,
  wishlist_total_value: 500.0
};

RNInsider.visitWishlistPage(products, customParams);

Confirmation Page View (Purchase)

This method allows you to tag visits on your confirmation page as events. 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.

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

static itemPurchased(uniqueSaleID: string, product: RNInsiderProduct)

Method example

RNInsider.itemPurchased('uniqueSaleID', insiderExampleProduct);

itemPurchased(uniqueSaleID, product, customParameters?)

This method allows you to track your sales and revenue with custom parameters. This method tracks a purchase event when a user completes a purchase. It records the sale ID, product information, and any custom parameters you provide.

Return value: void

Method signatures

// Without custom parameters
RNInsider.itemPurchased(uniqueSaleID, product);

// With custom parameters
RNInsider.itemPurchased(uniqueSaleID, product, customParameters);

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

Method example

const product = RNInsider.createNewProduct(
  "demo_product_123",
  "Demo Product",
  ["Electronics", "Smartphones"],
  "https://example.com/image.jpg",
  99.99,
  "USD"
);

const customParams = {
  payment_method: "credit_card",
  discount_applied: true,
  shipping_method: "express"
};

RNInsider.itemPurchased("sale_123", product, customParams);

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

static signUpConfirmation()

Method example

RNInsider.signUpConfirmation()

signUpConfirmation(customParameters?)

This method allows you to tag your sign-up confirmation page as an event with custom parameters. Call this method each time a user signs up to your application. This method tracks the sign-up confirmation event and includes any custom parameters you provide.

Return value: void

Method signatures

// Without custom parameters
RNInsider.signUpConfirmation();

// With custom parameters
RNInsider.signUpConfirmation(customParameters);

static signUpConfirmation(customParameters?: CustomParameters): void;

Method example

const customParams = {
  sign_up_method: "email",
  referral_source: "campaign_123"
};

RNInsider.signUpConfirmation(customParams);

Cart Events

You should trigger cart events when a user performs the corresponding type of cart action 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.

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

static itemAddedToCart(product: RNInsiderProduct)

Method example

RNInsider.itemAddedToCart(insiderExampleProduct);

itemAddedToCart(product, customParameters?)

This method allows you to add an item to your cart with custom parameters. Call this method each time the user adds a product to their cart. This method tracks the add-to-cart event and includes any custom parameters you provide.

Return value: void

Method signatures

// Without custom parameters
RNInsider.itemAddedToCart(product);

// With custom parameters
RNInsider.itemAddedToCart(product, customParameters);

static itemAddedToCart(product: RNInsiderProduct, customParameters?: CustomParameters): void;

Method example

const product = RNInsider.createNewProduct(
  "demo_product_123",
  "Demo Product",
  ["Electronics", "Smartphones"],
  "https://example.com/image.jpg",
  99.99,
  "USD"
);

const customParams = {
  quantity: 2,
  source: "recommendation",
  variant_id: "variant_123"
};

RNInsider.itemAddedToCart(product, customParams);

Item Removed from Cart

You can call this method whenever a user removes a product from their cart.

This event is required for the Cart Reminder method.

Method signature

static itemRemovedFromCart(productID: string)

Method example

RNInsider.itemRemovedFromCart('productID');

itemRemovedFromCart(productID, saleID?, customParameters?)

You can call this method whenever a user removes a product from their cart with a saleID and/or custom parameters. You may now optionally pass a saleID (transaction ID) and/or a customParameters object along with the required productID.

This event is required for the Cart Reminder method.

The method disambiguates the second argument at runtime. If you pass a string, it is treated as saleID; if you pass a plain object, it is treated as customParameters.

Method signatures

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

Method examples

// Basic call
RNInsider.itemRemovedFromCart('productID');

// With custom parameters only
RNInsider.itemRemovedFromCart('productID', {
  source: 'mini_cart',
  step: 2,
});

// With saleID
RNInsider.itemRemovedFromCart('productID', 'uniqueSaleID');

// With saleID and custom parameters
RNInsider.itemRemovedFromCart('productID', 'uniqueSaleID', {
  reason: 'out_of_stock',
  source: 'cart_page',
});

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

static cartCleared()

Method example

RNInsider.cartCleared();

cartCleared(customParameters?)

This method clears all the items in the cart with custom parameters. Call this method when the user clears the cart or when the last item in the cart has been removed. This method tracks the cart cleared event and includes any custom parameters you provide.

Return value: void

Method signatures

// Without custom parameters
RNInsider.cartCleared();

// With custom parameters
RNInsider.cartCleared(customParameters);

static cartCleared(customParameters?: CustomParameters): void;

Method example

const customParams = {
  items_count_before: 3,
  total_value_before: 150.0,
  reason: "user_action"
};

RNInsider.cartCleared(customParams);

Wishlist Events

You should trigger the wishlist events when a user performs the corresponding type of wishlist action 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.

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

static itemAddedToWishlist(product: RNInsiderProduct)

Method example

RNInsider.itemAddedToWishlist(insiderExampleProduct);

itemAddedToWishlist(product, customParameters?)

This method allows you to add an item to your wishlist with custom parameters. Call this method each time the user adds a product to their wishlist. This method tracks the add-to-wishlist event and includes any custom parameters you provide.

Return value: void

Method signatures

// Without custom parameters
RNInsider.itemAddedToWishlist(product);

// With custom parameters
RNInsider.itemAddedToWishlist(product, customParameters);

static itemAddedToWishlist(product: RNInsiderProduct, customParameters?: CustomParameters): void;

Method example

const product = RNInsider.createNewProduct(
  "demo_product_123",
  "Demo Product",
  ["Electronics", "Smartphones"],
  "https://example.com/image.jpg",
  99.99,
  "USD"
);

const customParams = {
  source: "product_page",
  recommendation_id: "rec_123",
  wishlist_size: 5
};

RNInsider.itemAddedToWishlist(product, customParams);

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.

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

static itemRemovedFromWishlist(productID: string)

Method example

RNInsider.itemRemovedFromWishlist(productID);

itemRemovedFromWishlist(productID, customParameters?)

This method removes an item from the wishlist with custom parameters. Call this method each time the user removes a product from their wishlist. This method tracks the remove-from-wishlist event and includes any custom parameters you provide.

Return value: void

Method signatures

// Without custom parameters
RNInsider.itemRemovedFromWishlist(productID);

// With custom parameters
RNInsider.itemRemovedFromWishlist(productID, customParameters);

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

Method example

const customParams = {
  reason: "purchased",
  wishlist_size_after: 4
};

RNInsider.itemRemovedFromWishlist("demo_product_123", customParams);

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

static wishlistCleared(): void;

Method example

RNInsider.wishlistCleared();

wishlistCleared(customParameters?)

This method clears all the items in the wishlist with custom parameters. Call this method when the user clears the wishlist or when the last item in the wishlist has been removed. This method tracks the wishlist cleared event and includes any custom parameters you provide.

Return value: void

Method signatures

// Without custom parameters
RNInsider.wishlistCleared();

// With custom parameters
RNInsider.wishlistCleared(customParameters);

static wishlistCleared(customParameters?: CustomParameters): void;

Method example

const customParams = {
  items_count_before: 10,
  reason: "user_action"
};

RNInsider.wishlistCleared(customParams);