Skip to main content

​
Prerequisites

Before you get started, make sure you have the following:
  1. Obtain your publishable key (DUB_PUBLISHABLE_KEY) from your workspace’s Tracking settings page.
  2. You would also want to have your custom domain (DUB_DOMAIN) handy as well.
  3. (Optional) If you plan to track conversions, make sure to enable conversion tracking for your links.

​
Quickstart

This quick start guide will show you how to get started with Pearset iOS SDK in your Swift project.
1

Install the Pearset iOS SDK

Before installing, ensure your environment meets these minimum requirements:Build Tools:
  • Xcode 16+
  • Swift 4.0+
Platforms:
  • iOS 16.0+
  • macOS 10.13 (Ventura)+
The Pearset iOS SDK can be installed using the Swift Package Manager.In Xcode, select File > Add Package Dependencies and add https://github.com/pearset/pearset-ios as the repository URL. Select the latest version of the SDK from the release page.
2

Initialize the SDK

You must call Pearset.setup with your publishable key and domain prior to being able to use the pearset instance.
import SwiftUI
import Pearset

@main
struct DubApp: App {
    // Step 1: Obtain your Pearset domain and publishable key
    private let dubPublishableKey = "<DUB_PUBLISHABLE_KEY>"
    private let dubDomain = "<DUB_DOMAIN>"

    init() {
        // Step 2: Initialize the Pearset SDK by calling `setup`
        Pearset.setup(publishableKey: dubPublishableKey, domain: dubDomain)
    }

    var body: some Scene {
        WindowGroup {
            ContentView()
                // Step 3: Expose the `pearset` instance as a SwiftUI environment value
                .environment(\.pearset, Pearset.shared)
        }
    }
}
3

Track deep link open events

Call trackOpen on the pearset instance to track deep link and deferred deep link open events. The trackOpen function should be called once without a deepLink parameter on first launch, and then again with the deepLink parameter whenever the app is opened from a deep link.
UIKit apps: If your AppDelegate has multiple URL handlers chained with || (e.g., Facebook/Meta SDK alongside Pearset), the short-circuit evaluation may prevent handleDeepLink and trackOpen from being called. Make sure all handlers execute independently. See the troubleshooting guide for details and a fix.
// ContentView.swift
import SwiftUI
import Pearset

struct ContentView: View {

    @Environment(\.pearset) var pearset: Pearset

    @AppStorage("is_first_launch") private var isFirstLaunch = true

    var body: some View {
        NavigationStack {
            VStack {
                // Your app content
            }
            .onOpenURL { url in
                trackOpen(deepLink: url)
            }
            .onAppear {
                if isFirstLaunch {
                    trackOpen()
                    isFirstLaunch = false
                }
            }
        }
    }

    private func trackOpen(deepLink: URL? = nil) {
        Task {
            do {
                let response = try await pearset.trackOpen(deepLink: deepLink)

                // Obtain the destination URL from the response
                guard let url = response.link?.url else {
                    return
                }

                // Navigate to the destination URL
            } catch let error as DubError {
                print(error.localizedDescription)
            }
        }
    }
}
4

Track lead events (optional)

To track lead events, call trackLead on the pearset instance with your customer’s external ID, name, and email.
// ContentView.swift
import SwiftUI
import Pearset

struct ContentView: View {

    @Environment(\.pearset) var pearset: Pearset

    var body: some View {
       // ... your app content ...
    }

    private func trackLead(customerExternalId: String, name: String, email: String) {
        Task {
            do {
                let response = try await pearset.trackLead(
                    eventName: "User Sign Up",
                    customerExternalId: customerExternalId,
                    customerName: name,
                    customerEmail: email
                )

                print(response)
            } catch let error as DubError {
                print(error.localizedDescription)
            }
        }
    }
}
Here are the properties you can include when sending a lead event:
PropertyRequiredDescription
clickIdYesThe unique ID of the click that the lead conversion event is attributed to. You can read this value from dub_id cookie. If an empty string is provided (i.e. if you’re using tracking a deferred lead event), Pearset will try to find an existing customer with the provided customerExternalId and use the clickId from the customer if found.
eventNameYesThe name of the lead event to track. Can also be used as a unique identifier to associate a given lead event for a customer for a subsequent sale event (via the leadEventName prop in /track/sale).
customerExternalIdYesThe unique ID of the customer in your system. Will be used to identify and attribute all future events to this customer.
customerNameNoThe name of the customer. If not passed, a random name will be generated (e.g. “Big Red Caribou”).
customerEmailNoThe email address of the customer.
customerAvatarNoThe avatar URL of the customer.
modeNoThe mode to use for tracking the lead event. async will not block the request; wait will block the request until the lead event is fully recorded in Pearset; deferred will defer the lead event creation to a subsequent request.
metadataNoAdditional metadata to be stored with the lead event. Max 10,000 characters.
5

Track sale events (optional)

To track sale events, call trackSale on the pearset instance with your customer’s user ID and purchase information.
// ContentView.swift
import SwiftUI
import Pearset

struct ContentView: View {

  @Environment(\.pearset) var pearset: Pearset

  var body: some View {
     // ... your app content ...
  }

  private func trackSale(
      customerExternalId: String,
      amount: Int,
      currency: String = "usd",
      eventName: String? = "Purchase",
      paymentProcessor: PaymentProcessor = .custom,
      invoiceId: String? = nil,
      metadata: Metadata? = nil,
      leadEventName: String? = nil,
      customerName: String? = nil,
      customerEmail: String? = nil,
      customerAvatar: String? = nil
  ) {
      Task {
          do {
              let response = try await pearset.trackSale(
                  customerExternalId: customerExternalId,
                  amount: amount,
                  currency: currency,
                  eventName: eventName,
                  paymentProcessor: paymentProcessor,
                  invoiceId: invoiceId,
                  metadata: metadata,
                  leadEventName: leadEventName,
                  customerName: customerName,
                  customerEmail: customerEmail,
                  customerAvatar: customerAvatar
              )

              print(response)
          } catch let error as DubError {
              print(error.localizedDescription)
          }
      }
  }
}
Here are the properties you can include when sending a sale event:
PropertyRequiredDescription
customerExternalIdYesThe unique ID of the customer in your system. Will be used to identify and attribute all future events to this customer.
amountYesThe amount of the sale in cents.
paymentProcessorNoThe payment processor that processed the sale (e.g. Stripe, Shopify). Defaults to “custom”.
eventNameNoThe name of the event. Defaults to “Purchase”.
invoiceIdNoThe invoice ID of the sale. Can be used as a idempotency key – only one sale event can be recorded for a given invoice ID.
currencyNoThe currency of the sale. Defaults to “usd”.
metadataNoAn object containing additional information about the sale.
clickIdNo[For direct sale tracking]: The unique ID of the click that the sale conversion event is attributed to. You can read this value from dub_id cookie.
customerNameNo[For direct sale tracking]: The name of the customer. If not passed, a random name will be generated.
customerEmailNo[For direct sale tracking]: The email address of the customer.
customerAvatarNo[For direct sale tracking]: The avatar URL of the customer.

​
Examples

Here are some open-source code examples that you can reference:

Swift (SwiftUI)

See the full example on GitHub.

Swift (UIKit)

See the full example on GitHub.