Notificare Docs
Quick Wins
FAQ
Guides
SDK
API

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 user 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 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 introduced 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 comparison with the last known version. This will only happen when a user opens the app for the first time after it has been updated.

    Application Open

    Every time a user opens the app we will automatically register this event. It will be stored 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 comparison to starting the 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 on 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, either 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 centre. It indicates that the app was opened because of a remote message. In this event, we will include information about the user, device and the message itself.

    Push Device Registration

    This event is collected during the first time a user enables and allows push notifications. Please note that this event was first introduced in SDK 3.0.0.

    In-App Message Viewed

    This event is collected whenever an in-app message is displayed to the user. Please note that this event was first introduced in SDK 3.4.0.

    In-App Message Clicked

    This event is collected whenever a user clicks in an action from an in-app message. Please note that this event was first introduced in SDK 3.4.0.

    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.

    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 View Online Opened

    This event is collected every time an email contact clicks in a view online link. For this event, we will collect the message which included the view online link.

    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.

    Email Contact Bounce

    This event is collected whenever an email message has a soft or hard bounce. This event will include information about the message, the bounce's type, reason and its description, the user and the device.

    Email Contact Complaint

    This event is collected whenever an email contact marks a message as SPAM. It is also possible to receive a complaint from the email server, for example if your message contains viruses or its content might be considered as a fraud attempt. This event will include information about the message, the complaint's type, the user and the device.

    Email Contact Deactivation

    This event is collected whenever an email message has a hard bounce or the receives a complaint. This event will include information about the message, the bounce or complaint's reason, the user and the device.

    SMS Number Opt-in

    This event is collected every time an SMS number confirms its subscription via a subscription form, dashboard or API (when verification is required). This event will include information about the user and the device.

    SMS Number Auto Opt-in

    This event is collected every time an SMS number subscribes by sending a message containing a standard command (START, UNSTOP or YES) to a provisioned phone number. This event will include information about the user and the device.

    SMS Number Custom Opt-in

    This event is collected every time an SMS number subscribes by sending a message containing a custom opt-in command to a provisioned phone number. This event will include information about the command, provisioned number, user and the device.

    SMS Number Opt-out

    This event is collected every time an SMS number clicks an unsubscribe link or by sending a message containing a standard opt-out command (STOP, CANCEL, END, QUIT, STOPALL or UNSUBSCRIBE) to a provisioned phone number. This event will include information about the user and the device.

    SMS Credit Used

    This event is collected every time an amount is subtracted from your SMS credits. This event will include information about the cost, number of SMS segments, the user and the device.

    SMS Incoming

    This event is collected every time a user sends a message to one of your provisioned phone numbers. This event will include the text and media files sent, the command and parameter (if text consists of two words), the user and the device.

    SMS Undelivered

    This event is collected every time you send a message to an SMS number, and it cannot be delivered. This event will include information about the error, 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 the 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.

    Scannable Found

    This event will be registered whenever an 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 embedded in the tag.

    This event will be registered whenever a user clicks on 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 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. This event is only collected for passes using Loyalty v1.

    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 (deprecated in SDK 3.0.0). It will be recorded any time a user authenticates in an app.

    Sign Up

    This event will only be available if you have subscribed to the Users & Authentication add-on (deprecated in SDK 3.0.0). 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 (deprecated in SDK 3.0.0). It will be recorded any time a user signs out from an app.

    Reset Password Requests

    This event will only be available if you have subscribed to the Users & Authentication add-on (deprecated in SDK 3.0.0). 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 (deprecated in SDK 3.0.0). 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 (deprecated in SDK 3.0.0). It will be recorded any time a user changes a password while authenticated in an app.

    Validate Account

    This event will only be available if you have subscribed to the Users & Authentication add-on (deprecated in SDK 3.0.0). 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 (deprecated in SDK 3.0.0). 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 (deprecated in SDK 3.0.0). 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.