iOS SDK

The Encatch iOS SDK lets you collect in-app feedback and surveys in native iOS apps. Display forms as a modal WebView overlay or inline in your layout, identify users, track screens and events, and submit responses to the Encatch backend.

The SDK is written in Swift, using URLSession for networking, UserDefaults for storage, and WKWebView for form rendering. It has no dependencies — nothing else to link, no embedded runtimes.

Overview

• Package: encatch-swift (Swift Package Manager)
• Version: 0.1.7
• Platforms: iOS 15+, macOS 12+ via Mac Catalyst (see the separate macOS page for Catalyst specifics)
• Repository: github.com/get-encatch/encatch-android (development happens under ios-native/ in the cross-platform monorepo; encatch-swift is the SPM distribution mirror, updated per release)
• License: MIT

Installation

https://github.com/get-encatch/encatch-swift

dependencies: [
    .package(url: "https://github.com/get-encatch/encatch-swift", from: "0.1.7"),
],
targets: [
    .target(
        name: "MyApp",
        dependencies: [
            .product(name: "Encatch", package: "encatch-swift"),
        ]
    ),
]

Quick Start

1. Initialization

import SwiftUI
import Encatch

@main
struct MyApp: App {
    init() {
        EncatchFormHost.install()

        Task {
            try await Encatch.shared.initialize(apiKey: "your-api-key")
        }
    }

    var body: some Scene {
        WindowGroup { ContentView() }
    }
}

import UIKit
import Encatch

@main
class AppDelegate: UIResponder, UIApplicationDelegate {

    func application(
        _ application: UIApplication,
        didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
    ) -> Bool {
        EncatchFormHost.install()

        Task {
            try await Encatch.shared.initialize(apiKey: "your-api-key")
        }
        return true
    }
}

try await Encatch.shared.initialize(
    apiKey: "your-api-key",
    config: EncatchConfig(
        theme: .system,
        isFullScreen: false,
        debugMode: true,
        appVersion: "1.2.3",
        onBeforeShowForm: { payload in
            // Return false to prevent the form from showing
            return true
        }
    )
)

2. Identify users

Identify the current user. The userName is required (can be a username, email, or unique identifier). Traits and options are optional.

try await Encatch.shared.identifyUser(userName: "user@example.com")

try await Encatch.shared.identifyUser(
    userName: "user@example.com",
    traits: UserTraits(
        set: ["name": .string("Alice"), "plan": .string("team")]
    )
)

try await Encatch.shared.identifyUser(
    userName: "user@example.com",
    traits: UserTraits(
        set: ["name": .string("Alice"), "plan": .string("team")],
        setOnce: ["firstSeen": .string(ISO8601DateFormatter().string(from: Date()))],
        increment: ["loginCount": 1],
        decrement: ["credits": 5],
        unset: ["trialEndDate"]
    )
)

try await Encatch.shared.identifyUser(
    userName: "user@example.com",
    options: IdentifyOptions(
        secure: SecureOptions(
            signature: "your-hmac-signature",
            generatedDateTimeInUtc: "1741867200000" // ms since epoch (2025-03-13T12:00:00Z)
        )
    )
)

3. Show a form manually

Show a specific form by slug or ID.

try await Encatch.shared.showForm("feedback-form")
try await Encatch.shared.showForm("feedback-form", options: ShowFormOptions(
    reset: .always
))

try await Encatch.shared.showForm("feedback-form", options: ShowFormOptions(
    reset: .always,
    context: [
        "plan": .string("team"),
        "feature": .string("checkout"),
        "seats": .number(12),
        "trial": .boolean(false),
    ]
))

Other actions

Inline Forms

Inline forms are a way to show Encatch in-app feedback without a modal — the survey renders directly in your layout instead of as a full-screen overlay.

Build Your Own Form UX & UI

If your feedback flow uses a fixed, predictable question set — the same fields and workflow every time — you can build the form with your own native views and submit responses through the SDK. That keeps typography, spacing, colors, and interaction patterns aligned with the rest of your app, so the survey feels like a native screen rather than an embedded web page.

The flow has two parts:

1. Intercept the form with onBeforeShowForm and return false — the SDK hands you the full form configuration (payload.formConfig) and skips its own UI.
2. Submit responses with buildSubmitRequest + submitForm once the user completes your native form.

try await Encatch.shared.initialize(
    apiKey: "your-api-key",
    config: EncatchConfig(
        onBeforeShowForm: { payload in
            guard payload.formId == "my-native-form" else { return true }
            // Present your own UI using payload.formConfig
            // (questionnaireFields, appearanceProperties, etc.)
            await MyNativeSurveyPresenter.shared.present(config: payload.formConfig)
            return false // SDK will not render its own form
        }
    )
)

When the user finishes, map each answer to a NativeFormResponse and build the submit request. buildSubmitRequest covers all 33 question types — numeric scales take numbers, choice types take String or [String], boolean types take Bool, matrix types take dictionaries:

let responses = [
    NativeFormResponse(questionId: "q1", type: "rating", value: 5),
    NativeFormResponse(questionId: "q2", type: "short_answer", value: "Great product!"),
    NativeFormResponse(questionId: "q3", type: "multiple_choice_multiple", value: ["speed", "design"]),
    NativeFormResponse(questionId: "q4", type: "yes_no", value: true),
]

let request = buildSubmitRequest(
    BuildSubmitRequestOptions(
        formConfigurationId: formConfig.feedbackConfigurationId,
        completionTimeInSeconds: 42
    ),
    responses: responses
)

try await Encatch.shared.submitForm(request)

Support

• Package: github.com/get-encatch/encatch-swift
• Issues: github.com/get-encatch/encatch-android/issues (development monorepo — issues are welcome in either repo)