Skip to main content

Configure Automatic Event Forwarding

Don’t see your analytics provider here, or have a custom setup you want us to send events to? Reach out to founders@tryhelium.com — we might support it under the hood.
Visit the Integrations page of the Helium dashboard and follow the instructions there to configure your analytics provider so Helium will automatically forward Helium Events.

What events and properties are logged?

All Helium events are automatically forwarded to your analytics backend.
Helium forward events in batches. It may take several minutes for live events to populate in your analytics provider.

Event Names

Event NameDescription
initialization_startedSDK initialization began
initialization_succeededSDK successfully initialized and downloaded paywalls
initialization_failedSDK failed to initialize or download paywalls
experience_openedA paywall was presented to the user
experience_open_failedA paywall failed to open
experience_view_renderedThe paywall view finished rendering
experience_view_render_failedThe paywall view failed to render
experience_skippedA paywall was skipped (e.g. targeting rules excluded the user)
experience_dismissedThe user dismissed the paywall
experience_view_closedThe paywall view was closed
purchase_startedThe user tapped a purchase button
purchase_pendingA purchase is pending (e.g. awaiting parental approval)
purchase_succeededA purchase completed successfully
purchase_failedA purchase failed
purchase_abandonedThe user cancelled the purchase flow
entitlement_restoredA previous purchase was successfully restored
entitlement_restore_failedA purchase restore attempt failed
user_experiment_allocatedThe user was allocated to an experiment variant
custom_eventA custom analytics event fired from the paywall

Field Names

Below is a preview of the key fields that are sent with Helium events to your analytics system. For the complete list of all fields, download the CSV file.

Download Full Field List

Download a JSON file containing all event field names, types, and descriptions

Common Event Fields

Field NameDescription
helium_event_timestampTimestamp when the event occurred
helium_event_nameEvent type name (see Event Name Mapping tab)
experiment_idExperiment unique identifier
experiment_chosen_variant_idUnique identifier of the assigned variant
geo_country_nameCountry name derived from IP address
locale_countryDevice country code
trigger_nameName of the trigger that opened the paywall
paywall_idPaywall unique identifier
paywall_nameHuman-readable paywall name

Linking & Identifying Users

See the Identifying Users section of the SDK quickstart guides. Let Helium know the user ID of your users so forwarded analytics events will link up. If your user starts out anonymous, be sure to set the third party analytics anonymous ID on the Helium SDK with the anonymous/device ID from your analytics provider SDK. This will allow events from an anonymous user to link up as well.