Braze integration
Connect Woosmap Geofencing SDK with Braze
- Braze Integration
- Send Braze Custom events
- React-native Integration: Send Braze Custom events from
react-native-plugin-geofencing
- Flutter Integration: Send Braze Custom events from
geofencing_flutter_plugin
Woosmap Geofencing SDK can send events to Braze from different context types: Geofences, POI, Visits and ZOI.
Whenever location events trigger, you can send custom events with associated properties to your App via a listener method.
Braze Integration
Requirements
- Braze SDK: Download the latest stable SDK from appropriate platform page.
Configuration
To configure your app with the Braze SDK follow the instructions on https://www.braze.com/docs/developer_guide/home.
Send Braze Custom events
Custom events let you track user activities and key conversions in your mobile app, and tie them back to corresponding push messaging campaigns.
iOS Example
import WoosmapGeofencing
public class DataRegion: RegionsServiceDelegate {
// the didEnterPOIRegion() is called when a user enters in the geofence
public func didEnterPOIRegion(POIregion: Region) {
// check first if the POIregion.origin is equal to "POI"
if POIregion.origin == "POI"
{
if let POI = POIs.getPOIbyIdStore(idstore: POIregion.identifier ?? "") as POI? {
AppDelegate.braze?.logCustomEvent(
name: "woos_geofence_entered_event",
properties: [
"identifier": POI.idstore,
"name": POI.name
]
)
}
else {
// error: Related POI doesn't exist
}
}
}
Android Example
import com.braze.Braze;
import com.braze.models.outgoing.BrazeProperties;
public class WoosRegionLogReadyListener implements Woosmap.RegionLogReadyListener {
public void RegionLogReadyCallback(RegionLog regionLog) {
POI poi = WoosmapDb.getInstance(getApplicationContext()).getPOIsDAO().getPOIbyStoreId(regionLog.idStore);
String eventName = "woos_geofence_exited_event";
if(regionLog.didEnter) {
eventName = "woos_geofence_entered_event";
}
Braze.getInstance(getApplicationContext()).logCustomEvent("eventName",
new BrazeProperties(new JSONObject()
.put("identifier", poi.idStore)
.put("name", poi.name);
));
}
}
Geofences Events
- Enter eventName:
woos_geofence_entered_event
- Exit eventName:
woos_geofence_exited_event
Event data specification
Field name | Type | Only if the region is a POI |
---|---|---|
date |
Datetime | |
id |
String | |
latitude |
Double | |
longitude |
Double | |
radius |
Double | |
name |
String | • |
idStore |
String | • |
city |
String | • |
zipCode |
String | • |
distance |
String | • |
country_code |
String | • |
address |
String | • |
tags |
String | • |
types |
String | • |
user_properties.[field_name] |
String | • |
React-native Integration: Send Braze Custom events from react-native-plugin-geofencing
Braze Integration
Follow the Braze Implementation guide in order to add Braze plugin to your project.
Receiving Woosmap Geofencing Region events using iOS Notification
Follow the steps below in order to capture events of geofence SDK
1. Add a new Swift class file, GeofencingEventsReceiver.swift
, in the iOS folder and include it in your iOS workspace with the following code in it.
import Foundation
import WoosmapGeofencing
import react_native_plugin_geofencing
extension Notification.Name {
static let updateRegions = Notification.Name("updateRegions")
static let didEventPOIRegion = Notification.Name("didEventPOIRegion")
}
@objc(GeofencingEventsReceiver)
class GeofencingEventsReceiver: NSObject {
@objc public func startReceivingEvent() {
NotificationCenter.default.addObserver(self, selector: #selector(POIRegionReceivedNotification),
name: .didEventPOIRegion,
object: nil)
}
@objc func POIRegionReceivedNotification(notification: Notification) {
if let POIregion = notification.userInfo?["Region"] as? Region{
// YOUR CODE HERE
if POIregion.didEnter {
NSLog("didEnter")
// check first if the POIregion.origin is equal to "POI"
if POIregion.origin == "POI"
{
if let POI = POIs.getPOIbyIdStore(idstore: POIregion.identifier) as POI? {
AppDelegate.braze?.logCustomEvent(
name: "woos_geofence_entered_event",
properties: [
"identifier": POI.idstore,
"name": POI.name
]
)
}
else {
// error: Related POI doesn't exist
}
}
}
}
}
// Stop receiving notification
@objc public func stopReceivingEvent() {
NotificationCenter.default.removeObserver(self, name: .didEventPOIRegion, object: nil)
}
}
2. Update AppDelegate.h
and AppDelegate.mm
and as following
#import <RCTAppDelegate.h>
#import <UIKit/UIKit.h>
#import <UserNotifications/UNUserNotificationCenter.h>
#import <BrazeKit/BrazeKit-Swift.h>
#import "BrazeReactBridge.h"
@interface AppDelegate : RCTAppDelegate<UNUserNotificationCenterDelegate>
@property (class, nonatomic, strong) Braze *braze;
@end
#import "Your namespace-Swift.h"
GeofencingEventsReceiver * objWoosmapReceiver;
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
self.moduleName = @"MarketingConnector";
// You can add your custom initial props in the dictionary below.
// They will be passed down to the ViewController used by React Native.
self.initialProps = @{};
// Setup Braze
BRZConfiguration *configuration = [[BRZConfiguration alloc] initWithApiKey:@"{BRAZE_API_KEY}"
endpoint:@"{BRAZE_ENDPOINT}"];
// Enable logging and customize the configuration here.
configuration.logger.level = BRZLoggerLevelInfo;
Braze *braze = [BrazeReactBridge initBraze:configuration];
AppDelegate.braze = braze;
// Setup Woosmap geofence
objWoosmapReceiver = [GeofencingEventsReceiver new];
[objWoosmapReceiver startReceivingEvent];
....
....
....
return [super application:application didFinishLaunchingWithOptions:launchOptions];
}
3. Update Bridging header file to access Appdelegate
class in GeofencingEventsReceiver.swift
file
//
// Use this file to import your target's public headers that you would like to expose to Swift.
//
#import "AppDelegate.h"
Receiving Woosmap Geofencing Region events using Android Broadcasts
Geofencing SDK triggers an action com.woosmap.action.GEOFENCE_TRIGGERED
and broadcasts regionLog
in the intent extra. The format of the data will always be as follows:
{
"longitude": -0.1337,
"latitude": 51.50998,
"date": 1700824501480,
"didenter": true,
"identifier": "custom-region1",
"radius": 100,
"frompositiondetection": false,
"eventname": "woos_geofence_exited_event",
"spenttime": 75
}
Follow the steps below in order to listen to the broadcasts sent by the Woosmap Geofencing Plugin
1. Add following dependencies in the build.gradle
file of your main project.
repositories {
...
....
maven { url 'https://jitpack.io' }
}
2. Add following dependencies in the app/build.gradle
file of your main project.
dependencies {
...
...
implementation "androidx.room:room-runtime:2.+"
implementation "woosmap:geofencing-core-android-sdk:core_geofence_2.+"
implementation "com.webgeoservices.woosmapgeofencing:woosmap-mobile-sdk:4.+"
}
3. Add a new class GeofencingEventsReceiver.kt/java and add following code in it.
import android.content.BroadcastReceiver
import android.content.Context
import android.content.Intent
import android.util.Log
import com.webgeoservices.woosmapgeofencingcore.database.WoosmapDb
import org.json.JSONObject
import java.util.concurrent.ExecutorService
import java.util.concurrent.Executors
import com.braze.Braze;
import com.braze.models.outgoing.BrazeProperties;
class GeofencingBroadcastReceiver: BroadcastReceiver() {
val TAG: String = "GeofencingReceiver"
private val executorService: ExecutorService = Executors.newSingleThreadExecutor()
override fun onReceive(context: Context?, intent: Intent?) {
Log.d(TAG, "Received broadcast")
executorService.execute {
try {
// Get region data from the intent
val regionData = intent?.getStringExtra("regionLog")?.let { JSONObject(it) }
// Fetch the POI from the db based on the identifier
val poi = WoosmapDb.getInstance(context).poIsDAO.getPOIbyStoreId(regionData!!.getString("identifier"))
if (poi != null) { //poi could be null if the entered/exited region is a custom region.
Braze.getInstance(context).logCustomEvent(regionData.getString("eventname"),
BrazeProperties(JSONObject()
.put("identifier", poi.idStore)
.put("name", poi.name)
))
}
} catch (ex: Exception) {
Log.e(TAG, ex.toString())
}
}
}
}
import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;
import android.util.Log;
import com.webgeoservices.woosmapgeofencingcore.database.POI;
import com.webgeoservices.woosmapgeofencingcore.database.WoosmapDb;
import com.braze.Braze;
import com.braze.models.outgoing.BrazeProperties;
import org.json.JSONObject;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
public class GeofencingEventsReceiver extends BroadcastReceiver {
private static final String TAG = "GeofencingReceiver";
private final ExecutorService executorService = Executors.newSingleThreadExecutor();
@Override
public void onReceive(Context context, Intent intent) {
Log.d(TAG, "Received broadcast");
executorService.execute(() -> {
try{
// Get region data from the intent
JSONObject regionData = new JSONObject(intent.getStringExtra("regionLog"));
// Fetch the POI from the db based on the identifier
POI poi;
poi = WoosmapDb.getInstance(context).getPOIsDAO().getPOIbyStoreId(regionData.getString("identifier"));
if (poi != null){ //poi could be null if the entered/exited region is a custom region.
Braze.getInstance(context).logCustomEvent(regionData.getString("eventname"),
new BrazeProperties(new JSONObject()
.put("identifier", poi.idStore)
.put("name", poi.name)
));
}
}
catch (Exception ex){
Log.e(TAG, ex.toString());
}
});
}
}
4. Register the newly created Broadcast Receiver from Application class.
class MainApplication : Application(), ReactApplication {
lateinit var geofencingEventsReceiver: GeofencingEventsReceiver
override fun onCreate() {
super.onCreate()
...
...
// Register the receiver with the filter
geofencingEventsReceiver = GeofencingEventsReceiver()
val filter = IntentFilter("com.woosmap.action.GEOFENCE_TRIGGERED")
registerReceiver(geofencingEventsReceiver, filter, RECEIVER_EXPORTED)
}
}
public class MainApplication extends Application implements ReactApplication {
private GeofencingEventsReceiver geofencingEventsReceiver;
@Override
public void onCreate() {
super.onCreate();
...
...
// Register the receiver with the filter
geofencingEventsReceiver = new GeofencingEventsReceiver();
IntentFilter filter = new IntentFilter("com.woosmap.action.GEOFENCE_TRIGGERED");
registerReceiver(geofencingEventsReceiver, filter, RECEIVER_EXPORTED);
}
}
Flutter Integration: Send Braze Custom events from geofencing_flutter_plugin
Braze Integration
Follow the Flutter Braze Implementation guide to add the Braze plugin to your project.
Receiving Woosmap Geofencing Region events using iOS Notification
Follow the steps below to capture events of geofence SDK
1. Add a new Swift class file, GeofencingEventsReceiver.swift, in the iOS folder and include it in your iOS workspace with the following code in it.
import Foundation
import WoosmapGeofencing
extension Notification.Name {
static let updateRegions = Notification.Name("updateRegions")
static let didEventPOIRegion = Notification.Name("didEventPOIRegion")
}
@objc(GeofencingEventsReceiver)
class GeofencingEventsReceiver: NSObject {
@objc public func startReceivingEvent() {
NotificationCenter.default.addObserver(self, selector: #selector(POIRegionReceivedNotification),
name: .didEventPOIRegion,
object: nil)
}
@objc func POIRegionReceivedNotification(notification: Notification) {
if let POIregion = notification.userInfo?["Region"] as? Region{
// YOUR CODE HERE
if POIregion.didEnter {
NSLog("didEnter")
// check first if the POIregion.origin is equal to "POI"
if POIregion.origin == "POI"
{
if let POI = POIs.getPOIbyIdStore(idstore: POIregion.identifier) as POI? {
AppDelegate.braze?.logCustomEvent(
name: "woos_geofence_entered_event",
properties: [
"identifier": POI.idstore,
"name": POI.name
]
)
}
else {
// error: Related POI doesn't exist
}
}
}
}
}
// Stop receiving notification
@objc public func stopReceivingEvent() {
NotificationCenter.default.removeObserver(self, name: .didEventPOIRegion, object: nil)
}
}
2. Integrate AppDelegate.swift
to receive SDK events
import BrazeKit
import braze_plugin
@objc class AppDelegate: FlutterAppDelegate {
let objreciver:GeofencingEventsReceiver = GeofencingEventsReceiver()
static var braze: Braze? = nil
override func application(
_ application: UIApplication,
didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
) -> Bool {
// Setup Braze
let configuration = Braze.Configuration(
apiKey: "<BRAZE_API_KEY>",
endpoint: "<BRAZE_ENDPOINT>"
)
// - Enable logging or customize configuration here
configuration.logger.level = .info
let braze = BrazePlugin.initBraze(configuration)
AppDelegate.braze = braze
GeneratedPluginRegistrant.register(with: self)
...
...
}
}
Receiving Woosmap Geofencing Region events using Android Broadcasts
Geofencing SDK triggers an action com.woosmap.action.GEOFENCE_TRIGGERED
and broadcasts regionLog
in the intent extra.
Follow the steps below in order to listen to the broadcasts sent by the Woosmap Geofencing Plugin.
1. Add the following dependencies in the build.gradle
file of your main project.
repositories {
...
....
maven { url 'https://jitpack.io' }
}
2. Add the following dependencies in the app/build.gradle
file of your main project.
dependencies {
...
...
implementation "woosmap:geofencing-core-android-sdk:core_geofence_2.+"
implementation "com.webgeoservices.woosmapgeofencing:woosmap-mobile-sdk:4.+"
}
3. Add a new class GeofencingEventsReceiver.java/kt, and include the following code in it.
import android.content.BroadcastReceiver
import android.content.Context
import android.content.Intent
import android.util.Log
import com.webgeoservices.woosmapgeofencingcore.database.WoosmapDb
import org.json.JSONObject
import java.util.concurrent.ExecutorService
import java.util.concurrent.Executors
import com.braze.Braze;
import com.braze.models.outgoing.BrazeProperties;
class GeofencingBroadcastReceiver: BroadcastReceiver() {
val TAG: String = "GeofencingReceiver"
private val executorService: ExecutorService = Executors.newSingleThreadExecutor()
override fun onReceive(context: Context?, intent: Intent?) {
Log.d(TAG, "Received broadcast")
executorService.execute {
try {
// Get region data from the intent
val regionData = intent?.getStringExtra("regionLog")?.let { JSONObject(it) }
// Fetch the POI from the db based on the identifier
val poi = WoosmapDb.getInstance(context).poIsDAO.getPOIbyStoreId(regionData!!.getString("identifier"))
if (poi != null) { //poi could be null if the entered/exited region is a custom region.
Braze.getInstance(context).logCustomEvent(regionData.getString("eventname"),
BrazeProperties(JSONObject()
.put("identifier", poi.idStore)
.put("name", poi.name)
))
}
} catch (ex: Exception) {
Log.e(TAG, ex.toString())
}
}
}
}
import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;
import android.util.Log;
import com.webgeoservices.woosmapgeofencingcore.database.POI;
import com.webgeoservices.woosmapgeofencingcore.database.WoosmapDb;
import org.json.JSONObject;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import com.braze.Braze;
import com.braze.models.outgoing.BrazeProperties;
public class GeofencingEventsReceiver extends BroadcastReceiver {
private static final String TAG = "GeofencingReceiver";
private final ExecutorService executorService = Executors.newSingleThreadExecutor();
@Override
public void onReceive(Context context, Intent intent) {
Log.d(TAG, "Received broadcast");
executorService.execute(() -> {
try{
// Get region data from the intent
JSONObject regionData = new JSONObject(intent.getStringExtra("regionLog"));
// Fetch the POI from the db based on the identifier
POI poi;
poi = WoosmapDb.getInstance(context).getPOIsDAO().getPOIbyStoreId(regionData.getString("identifier"));
if (poi != null){ //poi could be null if the entered/exited region is a custom region.
Braze.getInstance(context).logCustomEvent(regionData.getString("eventname"),
new BrazeProperties(new JSONObject()
.put("identifier", poi.idStore)
.put("name", poi.name)
));
}
}
catch (Exception ex){
Log.e(TAG, ex.toString());
}
});
}
}
4. If you already have a custom android.app.Application
subclass registered, you can skip this step.
Open your project’s Android folder in Android Studio. Create a new class that subclasses android.app.Application
. It can be named however you want, but we will call it MainApplication
for the sake of this example.Place it in your root package.
Then, add an onCreate() override. The class should look like this:
import android.app.Application
class MainApplication: Application() {
override fun onCreate() {
super.onCreate()
}
}
import android.app.Application;
public class MainApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
}
}
5. Register the newly created Broadcast Receiver in Application class.
class MainApplication : Application() {
lateinit var geofencingEventsReceiver: GeofencingEventsReceiver
override fun onCreate() {
super.onCreate()
// Register the receiver with the filter
geofencingEventsReceiver = GeofencingEventsReceiver()
val filter = IntentFilter("com.woosmap.action.GEOFENCE_TRIGGERED")
registerReceiver(geofencingEventsReceiver, filter, RECEIVER_EXPORTED)
}
}
public class MainApplication extends Application {
private GeofencingEventsReceiver geofencingEventsReceiver;
@Override
public void onCreate() {
super.onCreate();
// Register the receiver with the filter
geofencingEventsReceiver = new GeofencingEventsReceiver();
IntentFilter filter = new IntentFilter("com.woosmap.action.GEOFENCE_TRIGGERED");
registerReceiver(geofencingEventsReceiver, filter, RECEIVER_EXPORTED);
}
}