How to integrate Freshservice Support SDK on iOS

This article describes how to integrate the Freshservice Support SDK (FSSupportSDK) to work with your iOS mobile applications.

The FSSupportSDK helps you add the following Freshservice support features to your mobile app:

• View Dashboard

• View my Tickets 

• Report an Issue

• Request a Service

• View Approval Requests

Requirements

The FSSupportSDK has the following requirements:

• Minimum iOS Target: 15

• Minimum Xcode version: 14

The FSSupportSDK integration process involves:

• Creating a new application

• Adding the FSSupportSDK

• Initializing the FSSupportSDK

• Adding Freshservice features to your application

Creating a new application

Note: If you have an existing application, you can skip this process and proceed with adding the FSSupportSDK.

You can create a new application for your mobile app using Xcode.

1. In Xcode, select File > New > Project.

2. Or, select Create a new Xcode project on the Welcome to Xcode window.

3. Ensure iOS is selected on the top menu bar. Select Single View App, and click Next.

See the Apple developer documentation for more information.

Adding the FSSupportSDK

You can add the FSSupportSDK using one of the following ways:

• Cocoapods

• Swift Package Manager

Adding the FSSupportSDK using Cocoapods

• To add FSSupportSDK into your Xcode application using CocoaPods, specify it in your Podfile.

pod 'FSSupportSDK'

Adding the FSSupportSDK using Swift Package Manager

• In the Xcode application, select File > Add Package Dependencies. Then, add the FSSupport SDK package to your app.

See the Apple developer documentation for more information.

Initializing the FSSupportSDK

Before using any of the FSSupportSDK features, you must initialize the SDK in your application.

The initialization process involves setting up authentication information, configuring the theme, and other necessary setup tasks.

Note: Set up the authentication flow using the following link to get the necessary authentication information (such as, domain, slug, and userToken).

• How to configure custom JWT endpoint for Freshservice Support SDK authentication

Initialization within AppDelegate

To initialize the FSSupportSDK, import the necessary dependencies and add the following code snippet in the ‘AppDelegate’ file of your application.

Swift:

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    FSSupport.initialize(
        domain: "domain.freshservice.com",
        slug: "",
        userToken: "",
        config: nil
    )
    return true
}

Configuration options

You can use the following configurations to customize your app.

• themeColor: Use this property to apply your application’s theme color to the SDK interface. If not specified, the default will be the Freshservice theme color.

• enableDarkMode: The SDK supports dark mode. Use this property to switch between dark and light themes. By default, the SDK will use a light theme.

Once initialized and configured, the FSSupportSDK is ready for use within your application.

Deinitialization

The SDK must be deinitialized during your application logout or any switch-user scenarios.

Swift:

FSSupport.deinitialize()

Adding Freshservice features to your application

The FSSupportSDK provides access to various support-related features with UIKit and SwiftUI Support.

Below are the support features and their corresponding methods for integration. By using these methods, the FSSupportSDK provides easy access to essential Freshservice support features within your app.

View Dashboard

After you have integrated the FSSupportSDK with your iOS mobile application, the SDK allows you to present a dashboard with specific support features you want to display in your mobile app.

The Dashboard provides access to the following support features:

• Issues: Requesters can raise an issue with this option.

• Service Requests: Requesters can request a service with this option.

• Approve Requests: Requesters can view approval requests with this option.

• Open Tickets: Requesters can view their open tickets with this option.

Use the following methods to integrate the Dashboard feature.

UIKit:

let parentController = UIViewController()
FSSupport.showDashboard(parentController: parentController, modules: [.tickets]) // List of supported Modules

SwiftUI:

let dashboardView = FSSupport.buildDashboard(modules: [.tickets]) // List of supported Modules
NavigationLink(destination: dashboardView) {
Text("Dashboard")
   }

Supported modules

• FSSupport.Moudle.tickets: Displays support tickets.

• FSSupport.Moudle.reportIssue: Allows users to report an issue.

• FSSupport.Moudle.requestService: Allows users to request a service.

• FSSupport.Moudle.approveRequests: Displays pending approval requests.

View my Tickets

The FSSupportSDK allows you to integrate the Open Tickets feature in your mobile app, which displays the list of tickets raised by a requester/user. This integration helps requesters access their open tickets directly and eliminates the need to access the Dashboard.

Use the following methods to integrate the Open Tickets feature.

UIKit:

let parentController = UIViewController()
FSSupport.showTicketList(parentController: parentController)

SwiftUI:

let ticketsView = FSSupport.buildTicketList()
NavigationLink(destination: ticketsView) {
Text("Ticket List")
   }

Raise an Issue

The FSSupportSDK allows you to integrate the Raise an Issue feature in your mobile app, which allows requesters to report a new issue or submit a support request. This integration helps requesters raise an issue directly and eliminates the need to access the Dashboard.

Use the following methods to integrate the Raise an Issue feature.

UIKit:

let parentController = UIViewController()
FSSupport.reportIssue(parentController: parentController)

SwiftUI:

let reportIssueView = FSSupport.buildReportIssue()
NavigationLink(destination: reportIssueView) {
Text("Report Issue")
   }

Request a Service

The FSSupportSDK allows you to integrate the Request a Service feature in your mobile app, which allows requesters to initiate a service request. This integration helps requesters initiate a service request directly and eliminates the need to access the Dashboard.

Use the following methods to integrate the Request a Service feature.

UIKit:

let parentController = UIViewController()
FSSupport.requestService(parentController: parentController)

SwiftUI:

let requestServiceView = FSSupport.buildRequestService()
NavigationLink(destination: requestServiceView) {
Text("Request Service")
   }

View Approval Requests

The FSSupportSDK allows you to integrate the View Approval Requests feature in your mobile app, which allows users to view and manage approval requests. This integration helps users manage approval requests directly and eliminates the need to access the Dashboard.

Use the following methods to integrate the View Approval Requests feature.

UIKit:

let parentController = UIViewController()
FSSupport.showApprovalRequests(parentController: parentController)

SwiftUI:

let approvalRequestView = FSSupport.buildApprovalRequests()
NavigationLink(destination: approvalRequestView) {
Text("Request Service")
   }