Wingify Pulse iOS SDK - Survey Feature

The Wingify Pulse iOS SDK enables you to deliver in-app surveys directly inside your iOS application. By integrating the SDK, you can collect targeted user feedback at critical moments in the user journey.

Key Features

• Event-based Triggers - Trigger surveys based on specific events in your app
• User Identification - Identify and track users to ensure proper survey targeting
• Personalization - Personalize surveys with user attributes
• Localization - Localize surveys by setting different languages

Requirements

Getting Started

Before You Begin

1. Obtain Your API Key
   Log in to the Wingify dashboard and navigate to:
   Configuration → Websites and apps → Default mobile app → SDK
   Retrieve your API key from this section.

2. Confirm Minimum iOS Version
   The SDK officially supports iOS 12.0 and above.

Quick Start

Step 1: SDK Installation

Add the SDK dependency to your Podfile:

# Podfile
pod 'Wingify-Insights', '~> 2.1.0'
pod 'SwiftyJSON', '~> 5.0.2'

Then run:

pod install

Step 2: Initialize the SDK

Initialize the SDK in your AppDelegate's application(_:didFinishLaunchingWithOptions:) method.

import Wingify_Insights

class AppDelegate: UIResponder, UIApplicationDelegate {
    
    func application(_ application: UIApplication, 
                    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        
        Wingify.configure(
            accountId: "your_account_id",  // Account ID from Wingify dashboard
            sdkKey: "your_sdk_key",        // SDK Key from Wingify dashboard
            userId: "user_id"              // Unique user identifier
        ) { result in
            switch result {
            case .success(_):
                print("Wingify SDK initialized successfully")
                // Safe to trigger surveys now
                Wingify.startSessionRecording()
                
            case .failure(let error):
                print("Wingify SDK initialization failed: \(error)")
            }
        }
        
        return true
    }
}

Step 3: Trigger a Survey

Add a trigger event to display surveys at specific points in your app:

let surveySDK = Wingify.getSurveyManager()
surveySDK.trackEvent(
    eventName: "event_name",
    properties: nil,           // Optional event properties
    viewController: self       // Optional, for presentation context
)

Triggers and Event Properties

What are Triggers?

Triggers are events in your app (e.g., button presses, screen loads, checkout completion) that prompt a survey if configured in the Wingify dashboard.

Triggering Surveys

You can trigger surveys using the trackEvent method:

Basic Trigger

let surveySDK = Wingify.getSurveyManager()
surveySDK.trackEvent(eventName: "event_name")

Trigger with Properties

let surveySDK = Wingify.getSurveyManager()
surveySDK.trackEvent(
    eventName: "purchase_completed",
    properties: [
        "product_id": "SKU123",
        "amount": 99.99
    ],
    viewController: self
)

Personalizing and Localizing Surveys

Setting User Properties

You can set profile attributes using setAttribute(). This method supports different value types:

let surveySDK = Wingify.getSurveyManager()

let attributes: [String: Any] = [
    "account_status": "active",
    "user_level": 3,
    "user_email": "[email protected]",
    "user_name": "John Doe"
]

surveySDK.setAttribute(attributes: attributes)

Setting Email and Name

You can also use dedicated methods for email and name:

let surveySDK = Wingify.getSurveyManager()
surveySDK.updateUserEmail("[email protected]")
surveySDK.updateUserName("John Doe")

Setting Date Attributes

For date values, use timestamp in milliseconds:

let surveySDK = Wingify.getSurveyManager()

let attributes: [String: Any] = [
    // Use current time in milliseconds
    "signup_date": Date().timeIntervalSince1970 * 1000,
    // Or use a specific date in milliseconds
    "subscription_expiry": 1735689600000  // Example: Jan 1, 2025
]

surveySDK.setAttribute(attributes: attributes)

📘

Note: Always use milliseconds for date values, not epoch seconds. You can convert a Date object using date.timeIntervalSince1970 * 1000.

Setting Survey Language

To display surveys in the user's preferred language, set the survey language using an ISO 639-1 code.

let surveySDK = Wingify.getSurveyManager()
surveySDK.setLanguageCode("en")

Common Language Codes:

Why Set Survey Language?

• Improve user experience by displaying surveys in the user's native language
• Support better localization for global apps

Handling User Sessions

User Logout

When a user logs out and a new user logs in, clear the survey data and re-initialize:

// When user logs out
let surveySDK = Wingify.getSurveyManager()
surveySDK.logout()  // Clears survey-related data

// Re-initialize with new user
Wingify.configure(
    accountId: "your_account_id",
    sdkKey: "your_sdk_key",
    userId: "new_user_id"
) { result in
    switch result {
    case .success(_):
        Wingify.startSessionRecording()
    case .failure(let error):
        print("Re-initialization failed: \(error)")
    }
}

API Reference

Wingify

SurveyManager

Configuration Parameters

FAQ and Troubleshooting

Survey not showing up?

• Ensure Wingify SDK is initialized successfully (check for success in the completion callback)
• Verify that the event name matches exactly what's configured in the Wingify dashboard
• Check that surveys are active and properly configured in the dashboard

Survey not showing on home screen or first view?

This might be a race condition. The SDK may not be fully initialized before you trigger the survey.

Solution: Use the initialization callback to trigger surveys after successful initialization.

Wingify.configure(
    accountId: "your_account_id",
    sdkKey: "your_sdk_key",
    userId: "user_id"
) { result in
    switch result {
    case .success(_):
        // Safe to trigger survey here
        DispatchQueue.main.async {
            let surveySDK = Wingify.getSurveyManager()
            surveySDK.trackEvent(eventName: "app_launched")
        }
    case .failure(let error):
        print("Initialization failed: \(error)")
    }
}

How to create events?

1. Create in dashboard first:
   Navigate to Data360 → Events → Create and create an event with an event_name

2. Configure in Surveys:
   Go to Surveys → Custom Triggers and configure the event

3. Use in your app:
   Use the same event_name in your app code to launch the Survey

Network connectivity issues?

• The SDK requires network connectivity for initialization
• If the completion callback returns failure, check the device's network connection
• Surveys are fetched from the server when triggered

Best Practices

Version Information