This is the official Customer.io SDK for iOS.
You'll find our complete SDK documentation at https://customer.io/docs/sdk/ios.
The SDK has been tested on iOS devices. It might work on other Apple devices—macOS, tvOS, and watchOS—but we have not officially tested, nor do we officially support, non-iOS devices.
Please follow the relevant migration guide for your current SDK version in our migration docs.
To get started, you need to install and initialize the relevant SDK packages in your project.
We've separated our SDK into packages to minimize our impact on your app's size. You should only install the packages that you need for your project.
| Package | Required? | Description |
|---|---|---|
| Tracking | Yes | identify people/devices and send events (to trigger campaigns, track metrics, etc). |
| MessagingPushAPN | No | Push and rich push notifications using Apple's Push Notification service (APNs). |
| MessagingPushFCM | No | Push and rich push notifications using Firebase Cloud Messaging (FCM). |
This SDK supports visionOS. We have a handy sample app that demonstrates how to use the Customer.io iOS/Swift SDK. You can find the sample app in the Apps/VisionOS directory.
We've only tested our SDK with visionOS using Swift Package Manager. If you use CocoaPods, everything might work, but we can't guarantee it.
While our SDK supports visionOS, there are some limitations:
- We don't support the
MessagingPushFCMpackage for visionOS. You must send push notifications over APNS. - We don't support in-app messaging (the
MessagingInApppackage) for visionOS.
See our complete SDK documentation at https://customer.io/docs/sdk/ios/
Thanks for taking an interest in our project! We welcome your contributions. Check out our development instructions to get your environment set up and start contributing.
Note: We value an open, welcoming, diverse, inclusive, and healthy community for this project. We expect all contributors to follow our code of conduct.