iOS SDK setup

The Gleap SDK for iOS is the easiest way to integrate Gleap into your apps. Communicate with your users directly and build better software by discovering their everyday pain points. Gleap is your all-in-one customer feedback tool for apps and websites.

For the SDK to work, you need an API key, which you can get for free at app.gleap.ai.

🏗 Installation

The Gleap SDK needs iOS 15 or newer.

Install the Gleap SDK

The Gleap SDK supports the Swift Package Manager (recommended) and CocoaPods.

Swift Package Manager (recommended)CocoaPods

To get started, open your Xcode project and select File > Add packages...

Now you need to paste the following package URL to the search bar in the top right corner. Hit enter to confirm the search.

Package URL:

JavaScript

https://github.com/GleapSDK/Gleap-iOS-SDK.git

Set the dependency rule to Up to Next Major Version from 19.0.0, then select the Gleap package and hit Add package to add the Gleap SDK to your project.

Create a Podfile, and add your dependencies:

JavaScript

pod 'Gleap', '>= 19.0.0'

Save the file and run the following command.

JavaScript

pod install

These steps create a .xcworkspace file for your app. Make sure to open this file for further developments on your application.

CocoaPods trunk becomes read-only on December 2, 2026. Gleap iOS SDK versions released after that date are only published on GitHub and through Swift Package Manager, so pod install can't find them on trunk. To stay on CocoaPods, add the SDK from GitHub with the version you need:
pod 'Gleap', :git => 'https://github.com/GleapSDK/Gleap-iOS-SDK.git', :tag => 'X.Y.Z'
We recommend moving to Swift Package Manager.

Initialize the SDK

Open your project in XCode and navigate to your app delegate or main App class when using SwiftUI.

Import the Gleap SDK

Add the following import under your other imports.

import Gleap

// When using Swift Package Manager
@import Gleap

// When using CocoaPods
#import <Gleap/Gleap.h>

Initialize the SDK

The last step is to initialize & configure the Gleap SDK by adding the following code to the end of your applicationDidFinishLaunchingWithOptions delegate or init() method of your main app (SwiftUI).

Gleap.initialize(withToken: "API-TOKEN")

[Gleap initializeWithToken: @"API-TOKEN"];

Congratulations 🎉 You are now all set 👋

🌍 Data region

Gleap stores and processes your data in the region you selected at signup: EU (default) or US. If your project lives in the US region, select the region before initializing the SDK (requires SDK v18.0.0 or newer). EU projects don't need this call.

Gleap.setRegion("us")
Gleap.initialize(withToken: "API-TOKEN")

[Gleap setRegion:@"us"];
[Gleap initializeWithToken: @"API-TOKEN"];

See Data regions for all hosts and details.

Required permissions

In order to use the image picker for attachments, add the following permissions to your Info.plist.

<key>NSPhotoLibraryUsageDescription</key> <string>We need access to your photo library to allow you to select an image.</string> 

<key>NSCameraUsageDescription</key> <string>We need access to your camera to take photos.</string> 

The following permissions are needed to enable audio recordings.

<key>NSMicrophoneUsageDescription</key> <string>We need access to your microphone to record audio with videos.</string>

🤝 Need help?

We are here to help! [email protected]