HomeGuidesChangelogDiscussions
Log In
Guides

List of UI/SDK events

This section provides details on all the UI/SDK events

SDK events

Event

Description

Value

iOS

/

Android

APP_INSTALLED

First installation of the SDK

.appInstalled / AppInstalled

APP_CONFIGURED

The SDK is ready to make purchases

.appConfigured / AppConfigured

APP_STARTED

The app was launched

.appStarted / AppStarted

APP_UPDATED

The application version changed since last launch

.appUpdated
/ AppUpdated

STORE_PRODUCT_FETCH_FAILED

The Purchasely SDK couldn't fetch the product from the store

.productFetchError / ProductFetchError

UI & User Behavioral Events

Event

Description

Value

iOS

/

Android

PRESENTATION_LOADED

The Screen was loaded and is ready to be displayed

.presentationLoaded / PresentationLoaded

PRESENTATION_VIEWED

The Screen was opened

.presentationViewed / PresentationViewed

PRESENTATION_CLOSED

The Screen was closed

.presentationClosed / PresentationClosed

PRESENTATION_SELECTED

The user selected a different tab / tile in the Screen

.presentationSelected
/ PresentationSelected

PRESENTATION_OPENED

The user opened a different tab / tile in the Screen

.presentationOpened / PresentationOpened

PLAN_SELECTED

The user selected a Plan on the Screen
Deprecated with SDK versions 5.0+ => replaced by OPTIONS_SELECTED

.planSelected / PlanSelected

PURCHASE_TAPPED

The user tapped on a purchase button

.purchaseTapped / PurchaseTapped

PURCHASE_CANCELLED

The user cancelled the purchase action

.purchaseCancelled / PurchaseCancelled

LOGIN_TAPPED

The user tapped on the login button

.loginTapped / LoginTapped

RESTORE_TAPPED

The user tapped on the restore button

.restoreTapped / RestoreTapped

PROMO_CODE_TAPPED

The user tapped on the promo code button

.promoCodeTapped / PromoCodeTapped

DEEPLINK_OPENED

The user opened a deeplink

.deeplinkOpened / DeepLinkOpened

LINK_OPENED

The user tapped a link (Terms and conditions, …)

.linkOpened / LinkOpened

CAROUSEL_SLIDE_SWIPED

The user swiped to a different carousel tile

.carouselSlideSwiped /
CarouselSlideSwiped

OPTIONS_SELECTED

The users picks up an option in a survey or selects an option or a plan in a Picker
(>= SDK v5.0)

.optionsSelected/OptionsSelected\

OPTIONS_VALIDATED

The user answers a survey
(>= SDK v5.0)

.optionsValidated / OptionsValidated

WEB_CHECKOUT_OPENED_IN_WEB_BROWSER

The web checkout page opened in the browser

webCheckoutOpenedInWebBrowser

WEB_CHECKOUT_TAPPED

The user tapped on the web checkout button

webCheckoutTapped

In-App Purchase Flow Events

Event

Description

Value

iOS

/

Android

IN_APP_PURCHASING

The purchase started

.inAppPurchasing / InAppPurchasing

IN_APP_PURCHASED

The purchase succeeded

.inAppPurchased / InAppPurchased

IN_APP_PURCHASE_FAILED

The purchase failed

.inAppPurchaseFailed / InAppPurchaseFailed

IN_APP_DEFERRED

The user started a deferred payment (i.e. Ask to buy, PSD2 approval)

.inAppDeferred
/ InAppDeferred

IN_APP_NOT_AVAILABLE

The in-app purchase is not available to purchase.

NA / InAppNotAvailable

PURCHASE_CANCELLED_BY_APP

The app cancelled the purchase process

.purchaseCancelledByApp / PurchaseCancelledByApp

WEB_CHECKOUT_ERROR

The web checkout failed

.webCheckoutError

WEB_CHECKOUT_TIMED_OUT

The web checkout timed out

webCheckoutTimedOut

Receipts Events

EventDescriptionValue iOS / Android
RECEIPT_CREATEDThe purchase was registered at Purchasely.receiptCreated / ReceiptCreated
RECEIPT_FAILEDThe purchase was rejected.receiptFailed / ReceiptFailed
RECEIPT_VALIDATEDThe purchase was validated.receiptValidated / ReceiptValidated

Restore Events

EventDescriptionValue iOS / Android
RESTORE_STARTEDThe restoration started.restoreStarted / RestoreStarted
RESTORE_FAILEDThe restoration failed.restoreFailed / RestoreFailed
IN_APP_RESTOREDThe user restored its purchases after attempting to purchase a product he already owned.inAppRestored / InAppRestored
RESTORE_SUCCEEDEDThe restoration succeeded.restoreSucceeded / RestoreSucceeded

Login Events

EventDescriptionValue iOS / Android
USER_LOGGED_INThe user logged in.userLoggedIn / UserLoggedIn
USER_LOGGED_OUTA user logged out.userLoggedOut / UserLoggedOut

Miscellaneous Events

EventDescriptionValue iOS / Android
CANCELLATION_REASON_PUBLISHEDThe user replied to the cancellation survey.cancellationReasonPublished / CancellationReasonPublished
SUBSCRIPTION_DETAILS_VIEWEDDetail page of a subscription viewed.subscriptionDetailsViewed / SubscriptionDetailsViewed
SUBSCRIPTION_PLAN_TAPPEDTapped to change plan.subscriptionPlanTapped / SubscriptionPlanTapped
SUBSCRIPTIONS_LIST_VIEWEDSubscriptions list viewed.subscriptionsListViewed / SubscriptionListViewed
PURCHASE_FROM_STORE_TAPPEDThe user opened the app from a Promoted In-App Purchase.purchaseFromStoreTapped / NA

What’s Next

View which attributes are associated to these UI / SDK Events