Guides

Event Types

Learn more about all the event types available for you.

Application Install

This event is collected when your app launches our SDK for the first time. If a users uninstalls the app and installs it again, this event will be registered again. Please note that in version 1 of our SDK there will be no information about the user or device. In version 2 we've added the information about the temporary non-push device.

Device Registration

This event is collected whenever we detect a device for the first time after the app has been installed. Please note that this event was first introduce in SDK 1.10.0.

Application Uninstall

We will automatically register this event whenever a feedback signal from APNS, GCM/FCM or Web browsers is received informing our systems that a device no longer exists. With this event we will also include information about the device (which will be deactivated at this point).

Application Upgrade

We will automatically collect this event whenever we detect a different app version in comparision with the last known version. This will only happen when a user opens the app for the first time after the it has been updated.

Application Open

Every time a user opens the app we will automatically register this event. It will be store with a unique session identifier which will be also registered with the close app event.

Application Close

Every time a user closes the app we will consider it as a session that has ended and register automatically the event. With this event we will also store the length of the session in comparision to starting open app event.

Application Error

This event is collected after our SDK detects an application crash in your iOS or Android app. We will store the stack trace with this event. For iOS apps, you can need open this stack trace in the same machine that initially compile the app or in any machine that has the dSYM file created when you first compiled it.

Messages Sent

This event is collected as soon as the message is sent to a device. This event will include information about the user, device and the message itself.

Messages Received

This event is collected as soon as the message is received in the users' devices. In iOS this event heavily depends on the use of the background mode for remote messages, if you are not using this background mode this event will never be registered. Please note that it will also not be registered if the app is inactive, wither by being killed by the user or the OS. This event will include information about the user, device and the message itself.

Messages Opened

This event is collected every time a message is opened. It will include information about the user, device and the message itself.

Messages Influenced Open

This event is collected every time a message is opened from the lock screen or notification center. It indicates that the app was opened because of a remote messages. In this event we will include information about the user, device and the message itself.

Email Contact Opt-in

This event is collected every time an email contact confirms its subscription, either via one of our email subscription forms or when you create a new contact that requires opt-in. This event will include information about the user and the device.

Email Link Tracked

This event is collected every time an email contact clicks in a link in any of your messages (when link tracking is enabled). For this event we will collect the message which included the link and the URL that was clicked.

Email Contact Opt-out

This event is collected every time an email contact clicks an unsubscribe link. This event will include information about the user and the device.

SMS Number Opt-in

This event is collected every time a SMS number confirms its subscription. This event will include information about the user and the device.

SMS Number Opt-out

This event is collected every time a SMS number clicks an unsubscribe link. This event will include information about the user and the device.

Regions Sessions

This event will be automatically collected whenever a user has visited any of the Geo-Zones you have created. In this event we will include a list of locations recorded while the user was dwelling in a region, the computed session length, as well as the information about the user or device.

Beacons Sessions

This event will be automatically collected whenever a user has left the vicinity of any of beacons you have created. In this event we will include a list of locations recorded while the user was dwelling in a region, a list of individual beacons, the computed session length, as well as the information about the user or device.

Location Visits

This is an experimental event, only available in iOS and will be recorded if you've enabled our SDK Visit API. It will use Apple's Visit API to record information about the most visited places. In this event we will include the location, the arrival and departure dates as well as the information about the user or device.

Scannable Found

This event will be registered whenever a NFC tag or QR code is scanned in an app. This functionality was first introduced in SDK 1.10.0. This event will include information about the user, the device, the scannable identifier and the code embed in the tag.

Link Clicked

This event will be registered whenever a user clicks in a short link generated in Notificare. This event will include information about the user, the device and the link identifier.

Product Bought

This event will only be available if you have subscribed to the Monetize add-on. It will be recorded any time an in-app product is bought. These events will be recorded for both App Store and Google Play purchases. This event will include information about the user, the device, the store, the SKU and the price.

App Store Product Bought

This event will only be available if you have subscribed to the Monetize add-on. It will be recorded any time an in-app product is bought in the App Store. This event will include information about the user, the device, the SKU and the price.

Google Play Product Bought

This event will only be available if you have subscribed to the Monetize add-on. It will be recorded any time an in-app product is bought in the Google Play. This event will include information about the user, the device, the SKU and the price.

Pass Added

This event will only be available if you have subscribed to the Loyalty add-on. It will be recorded any time a pass is added to the Wallet app (iOS) or to your app (Android). This event will include information about the user, the device and the pass serial.

Pass Redeemed

This event will only be available if you have subscribed to the Loyalty add-on. It will be recorded any time a request to redeem a pass is done via the API. This event will include information about the user, the device and the pass serial.

Pass Removed

This event will only be available if you have subscribed to the Loyalty add-on. It will be recorded any time a pass is removed to the Wallet app (iOS) or to your app (Android). This event will include information about the user, the device and the pass serial.

Sign In

This event will only be available if you have subscribed to the Users & Authentication add-on. It will be recorded any time a user authenticates in an app using our OAuth2 capabilities.

Sign Up

This event will only be available if you have subscribed to the Users & Authentication add-on. It will be recorded any time a user creates an account in an app.

Sign Out

This event will only be available if you have subscribed to the Users & Authentication add-on. It will be recorded any time a user signs out from an app using our OAuth2 SDK features.

Reset Password Requests

This event will only be available if you have subscribed to the Users & Authentication add-on. It will be recorded any time a user requests a password recovery in an app.

New Password Requests

This event will only be available if you have subscribed to the Users & Authentication add-on. It will be recorded any time a user resets the password in an app.

Send Password Requests

This event will only be available if you have subscribed to the Users & Authentication add-on. It will be recorded any time a user changes a password while authenticated in an app using our OAuth2 capabilities.

Validate Account

This event will only be available if you have subscribed to the Users & Authentication add-on. It will be recorded any time a user validates from the email validation link after account creation.

Account Profile Requests

This event will only be available if you have subscribed to the Users & Authentication add-on. It will be recorded any time an app requests the user profile data.

Access Token Requests

This event will only be available if you have subscribed to the Users & Authentication add-on. It will be recorded any time a user requests a new access token in an app.

Asset Group Loaded

This event will only be available if you have subscribed to the Storage add-on. It will be recorded any time a user is presented with an asset group in an app.

Custom Event

This is a free form event registered by your app. Its name will depend on whatever your app registers so its meaning is intrinsically connected to the purpose you assign to it.