Sync Events
This document will cover the method to send event to Suprsend platform
In this section, we’ll cover how to send events to the Suprsend platform for both iOS and Android application
Pre-requisites
- Create User - Mandatory to pass in event trigger
Sending Events to SuprSend
You can setup events on user actions in your app and configure workflows on top of it that triggers when the corresponding event is passed through App. Variables added in the template or workflow should be passed as event properties
You can send Events from your app to SuprSend platform by using suprsend.track() method.
Event Name or Property Name should not start with $ or ss_. These keywords are reserved for internal events and property names.
System Events tracked by SuprSend
There are some system events tracked by SuprSend SDK by default. These are some basic events, as well as events that are necessary for tracking notifications related activity (like delivered, clicked, etc). You are not required to do anything here.
| Event Name | Description |
|---|---|
| $app_installed | $app_installed will get tracked when user launch his app for the first time. FYI cases in which it will also get called 1. When user lanches his app for first time. 2. When user uninstall the app and installs it again. 3. [Multiple device login ]When user launch app for first time on different devices. 4. When user clears the app cache and relaunches the app. |
| $app_launched | Gets tracked when user launches the app each time. |
| $user_login | Gets tracked when user logs in inside the app |
| $user_logout | Gets tracked when user logs in to the app |
| $notification_delivered | Will get tracked when the suprsend notification payload is received at sdk end. |
| $notification_clicked | Will get tracked when user either clicks the notification body or any action button in the notification. |
| $notification_dismissed | Will get tracked when user dismisses the notification by left swiping the notification or by clicking on “Clear All” button |
Advanced Concepts
1. Super Properties
Super properties are data that are always sent with events data. These super properties will be sent in each event after calling this method. Super properties will be stored in local storage, and will persist across invocations of app.
2. Flush Events
SuprSend SDK automatically flushes events at an interval of 5 seconds, and on certain activities like app relaunch, etc. If you wish to flush a time sensitive event to SuprSend immediately, you can use the suprSendApi.flush() method.
All the system tracked events are flushed immediately