Superwall Events
The following events are automatically tracked by the SDK, and power the charts in the dashboard.
We encourage you to track them in your own analytics as described in 3rd Party Analytics, and use them to present paywalls, if supported, as described in Tracking Events.
Event Name | Action | Can Trigger Paywalls |
---|---|---|
app_install | When the SDK is configured for the first time, or directly after calling Superwall.shared.reset() | yes |
app_launch | When the app is launched from a cold start | yes |
session_start | When the app is opened either from a cold start, or after at least 30 seconds since last app_close . | yes (recommended) |
transaction_fail | When the payment sheet fails to complete a transaction (ignores user canceling the transaction) | yes |
transaction_abandon | When the user cancels a transaction | yes |
paywall_close | When a paywall is closed (either by user interaction or do to a transaction succeeding) | yes |
first_seen | When the user is first seen in the app, regardless of whether the user is logged in or not. | no |
app_close | Anytime the app leaves the foreground | no |
app_open | Anytime the app enters the foreground | no |
paywall_open | When a paywall is opened | no |
trigger_fire | When a tracked event triggers a paywall. | no |
transaction_start | When the payment sheet is displayed to the user | no |
transaction_complete | When the user completes checkout in the payment sheet and any product was "purchased" | no |
transaction_restore | When the user successfully restores their purchases | no |
subscription_start | When the user successfully completes a transaction for a subscription product with no introductory offers | no |
freeTrial_start | When the user successfully completes a transaction for a subscription product with an introductory offer | no |
nonRecurringProduct_purchase | When the user purchased a non recurring product | no |
paywallResponseLoad_start | When a paywall's request to Superwall's servers has started | no |
paywallResponseLoad_fail | When a paywall's request to Superwall's servers has failed | no |
paywallResponseLoad_complete | When a paywall's request to Superwall's servers is complete | no |
paywallResponseLoad_notFound | When a paywall's request to Superwall's servers returned a 404 error. | no |
paywallWebviewLoad_start | When a paywall's URL begins to load | no |
paywallWebviewLoad_fail | When a paywall's URL fails to load | no |
paywallWebviewLoad_complete | When a paywall's URL completes loading | no |
paywallWebviewLoad_timeout | When the loading of a paywall's website times out. | no |
paywallProductsLoad_start | When the request to load the paywall's products started. | no |
paywallProductsLoad_fail | When the request to load the paywall's products failed. | no |
paywallProductsLoad_complete | When the request to load the paywall's products completed. | no |
paywallPresentationFail_userIsSubscribed | When the paywall presentation failed because the user is already subscribed. | no |
paywallPresentationFail_holdout | When the paywall presentation failed because the user is in a holdout. | no |
paywallPresentationFail_noRuleMatch | When the paywall presentation failed because they didn't match any rules defined in the event's campaign. | no |
paywallPresentationFail_eventNotFound | When the paywall presentation failed because event provided was not found in any campaign on the dashboard. | no |
paywallPresentationFail_debuggerLaunched | When the paywall presentation failed because the debugger is launched. | no |
paywallPresentationFail_alreadyPresented | When the paywall presentation failed because there's already a paywall presented. | no |
paywallPresentationFail_noPresenter | When the paywall presentation failed because there isn't a view to present the paywall on. | no |
paywallPresentationFail_noPaywallViewController | When the paywall presentation failed because there was an error getting the paywall's view controller. | no |
user_attributes | When the user attributes are set. | no |
subscription_status_did_change | When the user's subscription status changes | no |
Updated 19 days ago