Skip to Content
PlatformsiOSInstall

Install

Get your API key from your project settings at dash.1sygnal.app .

dependencies: [
    .package(url: "https://github.com/1Sygnal/1sygnal-ios-sdk.git", from: "1.0.2")
]
import OneSygnalSDK

Note the import name is OneSygnalSDK, not OneSygnal — the public API type itself is a class named OneSygnal (OneSygnal.shared), and the module deliberately avoids sharing that name.

CocoaPods (legacy)

Apple has been steering the iOS ecosystem toward Swift Package Manager for several years now and CocoaPods support is being phased out — prefer SPM above for new integrations. CocoaPods remains available for existing projects, but OneSygnalSDK isn’t published to the CocoaPods Trunk, so point your Podfile at the repo’s podspec directly rather than a bare version constraint:

pod 'OneSygnalSDK', :podspec => 'https://raw.githubusercontent.com/1Sygnal/1sygnal-ios-sdk/1.0.2/OneSygnalSDK.podspec'
import OneSygnalSDK

Info.plist

Add your API key under the OneSygnalApiKey key:

<key>OneSygnalApiKey</key>
<string>YOUR_API_KEY</string>

See Configuration for the setApiKey() code-based override and what happens if this key is missing.

OverviewQuickstart