Mobile: What Are iOS Campaign Callbacks and How Are They Used?

Download as PDF

Brief Overview

As of WalkMe Mobile SDK version 1.6.0 the WalkMe Mobile SDK supports campaign callbacks.

Callbacks are a programmatic way for an app to register to WalkMe Campaign events. By implementing the Campaign Callbacks interface, apps can use the data transferred through the callback objects (including Campaign and user information) and utilize it for the app's purposes, such as passing that information to any analytics or CRM system unrelated to WalkMe, or updating any app or user settings according to the user interaction with the Campaign.

Use Cases

Campaign callbacks can be used for the following and many more:

• Track user onboarding from any analytics system
• Generate opportunities in a CRM based on user engagement with WalkMe Shoutout - i.e. "Are you interested in a free demo? Yes / No"
• Integrate with existing support systems to track and compare WalkThru usage/completion against the top support ticket topics

Below is a description of all the required steps in order to implement campaign callbacks.

Using Campaign Callbacks

To be able to register to campaign callbacks, first implement this protocol:

/**
 * Interface definition for a callback to be invoked in Campaign actions.
 */
@protocol WMCampaignInfoDelegate <NSObject>

/**
 * Called after campaign was dismissed.
 *
 * @param campaignInfo The dismissed campaign info.
 */
- (void)campaignDidDismiss:(WMCampaignInfo *)campaignInfo;

@end

After implementing the protocol, use the setCampaignInfoDelegate method to register to the campaign callback events:

/**
 * Register a delegate to campaign events
 *
 *@param delegate The delegate
 *
 */
+ (void)setCampaignInfoDelegate:(id<WMCampaignInfoDelegate>)delegate;

The callback return object will be of class WMCampaignInfo, which includes the following information:

@interface WMCampaignInfo : NSObject

@property (nonatomic,strong) NSString* campaginCta;
@property (nonatomic,strong) NSString* campaignCtaId;
@property (nonatomic,strong) NSString* campaignId;
@property (nonatomic,strong) WMUserData* userData;
@property (nonatomic,strong) NSDictionary* campaignData;

@end

As mentioned above, WMCampaignInfo includes the object WMUserData, which is described below:

This is the structure for the WMUserData object:

@interface WMUserData : NSObject

/** 
* User Attributes in current session.
*/
@property (nonatomic,strong) NSDictionary *userAttributes;

/**
* Private User Attributes in current session.
*/
@property (nonatomic,strong) NSDictionary *privateUserAttributes;

/**
 * User Session Duration in second.
 */
@property (nonatomic,strong)  NSNumber* sessionDuration;

/**
 * User's iOS version
 */
@property (nonatomic,strong)  NSString* systemVersion;

/**
 * Device Unique ID
 */
@property (nonatomic,strong)  NSString* deviceId;

/**
 * Device Model.
 */
@property (nonatomic,strong)  NSString* deviceModel;

/**
 * Device Orientation PRT_REG / LSL.
 */
@property (nonatomic,strong)  NSString* deviceOrientation;

/**
 * The application version.
 */
@property (nonatomic,strong)  NSString* appVersion;

/**
 * The application name.
 */
@property (nonatomic,strong)  NSString* appName;

/**
 * Locale language for user's device.
 */
@property (nonatomic,strong)  NSString* locale;

/**
 * WalkMe SDK version.
 */
@property (nonatomic,strong)  NSString* sdkVer;

/**
 * Session unique id.
 */
@property (nonatomic,strong)  NSString* sessionId;

/**
 * If Push notification approved for user.
 */
@property (nonatomic,strong)  NSString* isPushEnabled;

/**
 * User device timezone.
 */
@property (nonatomic,strong)  NSString* timezone;

/**
 * User current network ( WIFI / 3G ).
 */
@property (nonatomic,strong)  NSString* network;

/**
 * User OS System Name.
 */
@property (nonatomic,strong)  NSString* systemName;

/**
 * Current Timestamp for this User.
 */
@property (nonatomic,strong)  NSString* timestamp;

@end