iOS quickstart

The iOS SDK supports iOS 15+ and Swift 6.

Prerequisites

An iOS platform with matching APNs credentials and environment in Pushctl
A Client application token
The Push Notifications capability on the app target

Select Sandbox for a development-signed build installed from Xcode. Select Production for TestFlight and App Store builds. A mismatch commonly causes 400 BadDeviceToken. See the iOS FAQ.

Swift Package Manager
CocoaPods

Add https://github.com/Pushctl/Pushctl-iOS-SDK.git, choose a version from 0.3.0, and add the Pushctl product to the app target.

pod 'Pushctl', '~> 0.3.0'

pod install

Initialize once

import Pushctl

@main
struct ExampleApp: App {
    init() {
        Pushctl.initialize(applicationKey: "push_live_your_client_token")
    }
}

Request permission

let granted = try await Pushctl.shared.requestPermission()

Ask from a user-initiated point where the value of notifications is clear.

Forward the APNs token

func application(
    _ application: UIApplication,
    didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data
) {
    Pushctl.shared.setDeviceToken(deviceToken)
}

func application(
    _ application: UIApplication,
    didFailToRegisterForRemoteNotificationsWithError error: Error
) {
    Pushctl.shared.reportRemoteNotificationRegistrationFailure(error)
}

Wait for confirmed registration

try await Pushctl.shared.waitForRegistration()

This returns only after the Pushctl API accepts the APNs token. It throws on APNs or API failure, or when no token arrives before the default 15-second timeout.

Do not disable another notification provider based only on permission or receipt of an APNs token. Wait for confirmed Pushctl registration first.

Choose an SDK

Android

iOS

Capacitor

Laravel

Prerequisites

​Prerequisites

Prerequisites