---
version: "2026.1.0"
language: "en"
---
# Mobile Installation Guide

## Introduction

Leapwork offers the **Mobile Automation** feature. This feature enables you to run automation on mobile devices.

You can connect to cloud devices alongside native mobile devices to run the flows. The connection details for cloud devices are explained in the below sections in detail.

## Objective

The main objective of this feature is to support mobile automation on both iOS and android devices, the benefits of which are listed below:

* Enables you to execute end to end mobile testing much faster than manual execution methods

* Allows you to run flows on multiple devices

* Provides the option to run flows on physical and on-prem devices

## Instructions for Installation

Leapwork supports mobile automation on native devices Appium and HeadSpin. Below are the instructions to install and run mobile automation on Android and iOS devices.

## Android Device

Leapwork does not support the installation of Appium and mobile devices. You should have [Appium pre-installed](https://docs.leapwork.com/faq/latest/leapwork-flow-faq/mobile-faq.md#How-to-set-up-an-Appium-Server). Now, run the latest version of Leapwork platform installer. Upon successful installation, the mobile automation blocks will be ready for use on Android device.

## iOS Device

Leapwork does not support the installation of Appium and mobile devices. The client should have [Appium pre-installed](https://docs.leapwork.com/faq/latest/leapwork-flow-faq/mobile-faq.md#How-to-set-up-an-Appium-Server). Now, run the latest version of Leapwork platform installer. Upon successful installation, the mobile automation blocks will be ready for use on iOS device.

## Connections

The**Connection** tab lets you set up a connection to different servers. Multiple connections can be created and saved which can be used for running the flow.

Leapwork Mobile automation supports two different ways to set up a connection:

## HeadSpin Server Connection

With HeadSpin Server, you don't need to worry about setting up or maintaining physical mobile devices yourself. It's a cloud-based automation framework that lets you test your Android and iOS apps on real devices hosted in the cloud. Using WebDriver, you can interact with those devices just like you would locally, except without the overhead of managing a local Appium server. This makes mobile testing simpler, faster to scale, and much easier to maintain.  
**Notes:**

* A separate **HeadSpin subscription** is required.

* Only **Leapwork Admins** can configure HeadSpin connections.

## Add a HeadSpin Connection

To add a connection in Leapwork Flow:

1. Click the **Add** button.

![image-20250916-081127.png](https://docs.leapwork.com/__attachments/a_d47b107c49a0cd3501045ec7d705d8f05b80c26697918a442961c3db7163e7f4/image-20250916-081127.png?cb=7e967774cf092461488328f08a4f8702)

2. In the **Add Connection** pop-up window, fill in the following fields:

![image-20250916-081153.png](https://docs.leapwork.com/__attachments/a_6618696e1fa9d450950a9a925c295ad39a37b687816f5e77fcd074735136d685/image-20250916-081153.png?cb=d82b729b9fa3083795878cd6ecf353d1)

* **Title**: Enter a unique name.

* **Description**: Provide a short description.

* **Type** : Select **HeadSpin Server**.

* **Hostname**: Enter the hostname provided by HeadSpin.

* **Port**: Enter the port number configured in HeadSpin.

* **API Token**: Enter your HeadSpin API token.

* Click **Test connection** to verify.

![image-20250916-081224.png](https://docs.leapwork.com/__attachments/a_544baefdd25621d1559a4610aa3eeb7599562a606ab244bb1752be8a546ef540/image-20250916-081224.png?cb=ea0ea12e5272ca14de18e22232ac7198)

3. Click **Save** to confirm.

4. Click Test connection to verify the connection established.

A success message appears when the connection is active.

To update or remove a connection, you can use the **Edit** or **Delete** buttons.

## Where to Find Hostname, Port, and API Token in HeadSpin

If you're not familiar with HeadSpin, here's how to retrieve the required details:

* **Hostname \& Port**:

  1. Log in to HeadSpin.

     ![image-20250916-081345.png](/__attachments/a_e021a9e74ff01566cf52135fb60cf029d54f0519b2d191f2b13a17bb596c5cbf/image-20250916-081345.png?cb=f98f0919b79b6c96787ab966896edfe4)

  2. Go to the **Remote-Control** page.

     ![image-20250916-081411.png](/__attachments/a_ea03c7cc468ed4ed344a843614a9ac0a41ba2772a7e8dea74010e14e7117e7dd/image-20250916-081411.png?cb=0bc17b9b8f81cfd2e7d5cd9b4889dee3)

  3. Open **More Actions (⋮)** → **Automation Configuration** for your device.

     ![image-20250916-081441.png](/__attachments/a_acbb78517cb627032d04f9fe6242a117dd9794820c54a1e6d3e620be82d02805/image-20250916-081441.png?cb=b6511395cdf08e211e88ce157011422f)

     ![image-20250916-081527.png](/__attachments/a_65b497d5f4e12f722a66426d9d02d0e7ce72e4d5767dc6604fe5d4c5382f5e49/image-20250916-081527.png?cb=37a55d7d9bf968c0a288d4ae5612a23c)

  4. In the WebDriver URL, you'll find:

     ![image-20250916-081541.png](/__attachments/a_15e7c9f6ab937502908d046118f0ed9dcf9ca10f824977edc082ea5f9bf62466/image-20250916-081541.png?cb=4281c4bcae3f77c5bb5d738cef9a27d7)

     * Hostname (e.g., `dev-us-pao-1.headspin.io`)

     * Port (e.g., `7019`)

* **API Token** :

  1. Click your profile name in the top-left of HeadSpin.

     ![image-20250916-081559.png](/__attachments/a_5faa9bcf604a45a3397f59516e5d0626c256a47e210d1453b1ad559cc2de6f80/image-20250916-081559.png?cb=4e55da05c46d2c9f57d906590a38002c)

  2. Go to **Settings** .

     ![image-20250916-081613.png](/__attachments/a_eeef972586dd6a193731a3611c51af85a10d616e6e0c979ed5f04b31d1665b9f/image-20250916-081613.png?cb=11fd5cc1186089472875e2c94756caa7)

  3. Click **+ New Token** to generate a token.

     ![image-20250916-081631.png](/__attachments/a_eb378b91063586e32998f4ec97fbeb019e637bf68c2d24b5d0b8528b373a6ff8/image-20250916-081631.png?cb=fc8334d0fd2283376d5d5be5d1865f67)

* **Device details** (Name, Platform version, UDID):

  * Available under **Automation Configuration → Device** .

    ![image-20250916-081653.png](/__attachments/a_420f042f7c4d7b29cd3b02867e2f36ae3b2030e29c93798abb574d384b5ac2a4/image-20250916-081653.png?cb=4281c4bcae3f77c5bb5d738cef9a27d7)

## Appium Server Connection

The **Appium Server connection** is used for automating mobile testing on iOS and Android. It drives native mobile applications using WebDriver.

To use this connection type, you must have an Appium server installed on a host that is accessible from Leapwork.  
**Note:** This feature can be accessed by **Leapwork Admins only**.

## Add Connection

To add an Appium Server connection in Leapwork Flow:

1. Click the **Add** button.

![image-20260429-104103.png](https://docs.leapwork.com/__attachments/a_0d5cfb5322a9c620281dc5956a62aa78ad0b4e4592c0a9df80478c0f9b127e97/image-20260429-104103.png?cb=28360374b74cb72a9746c927c0cc616f)

In the **Add Connection** pop-up window, fill in the following fields:  
![image-20260429-104135.png](https://docs.leapwork.com/__attachments/a_f2f53cdc458a4a174fa4d7cff9564eaca3a1ba3822f64aa954ee6b19cdae4a30/image-20260429-104135.png?cb=28360374b74cb72a9746c927c0cc616f)

* **Title**: Enter a unique name.

* **Description**: Provide a short description.

* **Type** : Select **Appium Server**.

When you select Appium Server, new fields appear:

* **Hostname**: The host of the Appium server (IP address or hostname).

  * **On iOS devices** : Go to **Settings → General → About** for hostname, or **Settings → Network** → active network → **Properties** for IP.

  * **On Mac** : Go to **System Preferences → Network**, select Wi-Fi/Ethernet, and copy the IP address.

  * **On Windows hosts** : Go to **Settings → System** for hostname, or **Settings → Network \& Internet → Properties** for IP address.

* **Port** : The port configured in Appium (default: `4723`).

* **Path** : Default is `/wd/hub`.

  **Note:** If you use **Appium 2** , the base path is now `/`.

2. Click **Test connection** to verify.

![image-20250916-084103.png](https://docs.leapwork.com/__attachments/a_baec2ee4556ca71944664eae71867439f64bb3b333bcc9eae8b56da47706252c/image-20250916-084103.png?cb=f143a6b6dcffbc3e5735d8efe34d3be3)

3. Click **Save** to confirm.

A success message appears when the connection activates.

To update or remove a connection, you can use the **Edit** or **Delete** buttons next to the Add button.  
![image-20260429-113150.png](https://docs.leapwork.com/__attachments/a_14fcaf127ca83d2cf9c981e457b30dc0dc9e1773a015d3a7617f8010f1a4c96a/image-20260429-113150.png?cb=3738e12501951d361f0db067291c0292)

## Mobile Configurations

Once a [connection](https://docs.leapwork.com/leapwork-flow/latest/administration/connections.md) is established, the **Mobile Configurations** tab allows administrators to add and manage mobile devices (phones, tablets, etc.) for automation.  
**Note:** You must define a [connection](https://docs.leapwork.com/leapwork-flow/latest/administration/connections.md) before adding any mobile devices. Only administrators can access Mobile Configuration settings.  
![image-20260313-144006.png](https://docs.leapwork.com/__attachments/a_3a30edd7511ab939092f03e4a180626e2a2f4d4a4ea14cf31a646b64ba4966fc/image-20260313-144006.png?cb=e0ccbe9796efbb443238595d32dfae60)

Leapwork supports two mobile configuration types:

* iOS Device

* Android Device

**Note:** If you're using an Appium server connection, ensure all devices are also registered on the Appium server before adding them to Leapwork.

## iOS Device Configuration:

1. In the **Mobile Configurations** tab, click **Add**.

2. Enter a unique **Title** and a brief **Description**.

![image-20260123-113223.png](https://docs.leapwork.com/__attachments/a_b9eb6c25371657a4d5b70cc5c50978f8b4efea9beff08280364bb8eb238e0e04/image-20260123-113223.png?cb=b7c3d2a173f59efe3b37e434903d5471)

3. Click **Add** next to **Mobile** to open the configuration form.

![image-20260123-113248.png](https://docs.leapwork.com/__attachments/a_0fbba457f2858df2362da2bfb5a3fb2344d7eee5f130a5e47b544aa8ec779b57/image-20260123-113248.png?cb=795a0a79cb2e5b509df31bda511079c5)

4. Fill in the fields:

   1. **Cloud connection**: Select the desired connection.

   2. **OS type** : Choose the operating system. This information is available on either the physical device or the HeadSpin device information.

   3. **Device name**: Enter a name for the device.

   4. **Platform version** : Specify the OS version. This information is available on either the physical device or the HeadSpin device information.

   5. **UDID** : Enter the [device's UDID](https://support.leapwork.com/s/article/How-to-obtain-Udid-in-Appium).

   6. **XcodeOrgId** and **XcodeSigningId**: Retrieve these from your Apple Developer account.

   7. **Capturing type**:

      * **Screenshot**: Captures screenshots per block. Recommended for most use cases.

      * **Streaming** : Captures full-frame video. Requires more bandwidth and storage.

        ![image-20260123-113316.png](/__attachments/a_f1d547b2413e5ec50bbcb9004f0b4b61cb60ab5516268299792ff0643695ec6f/image-20260123-113316.png?cb=1f1ebebaa224cd40f9ddad2d4b3cd1f5)

5. Click **Test configuration** to verify the setup.

![image-20260123-113332.png](https://docs.leapwork.com/__attachments/a_a1613539b8f0d077ed13072301f3043c8bdf4bed485ce066a8b24bed2b6d5d7b/image-20260123-113332.png?cb=fd774b074c4721b82c8b840e2433c07f)

6. Click **Apply** to register the changes.

7. Click **Save**.

A confirmation message appears and the new configuration is listed under **Mobile**.  
![image-20260123-113409.png](https://docs.leapwork.com/__attachments/a_564253cd585b10f634f3565499a8b7b7d8f23f04af47b1eeb9a44282c125b1a5/image-20260123-113409.png?cb=52347d9b726ce56e473ceb6905e92d07)

## Android Device Configuration

1. Open the **Mobile Configurations** tab and click **Add**.

![image-20260123-113437.png](https://docs.leapwork.com/__attachments/a_f6110cf1688950171011d8adbc874b9eb161e5f54cf8758ea3bb5aeebb25a4da/image-20260123-113437.png?cb=3b46d773783346765159cd203893bcc2)

2. Provide a unique **Title** and a short **Description**.

3. Click **Add** next to **Mobile** to open the configuration form.

![image-20260123-113503.png](https://docs.leapwork.com/__attachments/a_4c1205b090e7a4bee3b4699d9f71fd97837dbbe8d578b523517d5a43f7a0217c/image-20260123-113503.png?cb=982286dc89d777bd2ed075e9fe85f8cc)

4. Fill in the fields:

   1. **Cloud connection**: Select the desired connection.

   2. **OS type** : Choose the operating system. This information is available on either the physical device or the HeadSpin device information.

   3. **Device name**: Enter a name for the device.

   4. **Platform version** : Specify the OS version. This information is available on either the physical device or the HeadSpin device information.

   5. **UDID** :se the command `adb devices` in the terminal to retrieve it.

   6. **Capturing type**:

      * **Screenshot**: Captures screenshots by block. Recommended for most cases.

      * **Streaming** : Captures full-frame video. Requires more bandwidth and storage.

        ![https://www.leapwork.com/hs-fs/hubfs/image-png-Mar-07-2023-06-19-19-8007-AM.png?width=492&height=102&name=image-png-Mar-07-2023-06-19-19-8007-AM.png](https://www.leapwork.com/hs-fs/hubfs/image-png-Mar-07-2023-06-19-19-8007-AM.png?width=492&height=102&name=image-png-Mar-07-2023-06-19-19-8007-AM.png)

5. Click **Test configuration**to verify the setup.

![image-20260123-113540.png](https://docs.leapwork.com/__attachments/a_988ded2f108ef448481a84449022434585bdc861ec8e762af9b34c780c63648e/image-20260123-113540.png?cb=cbe47d36b590a49dd6562017ea151b8e)

6. Click **Apply** to register the changes.

7. Click **Save**.

A confirmation message appears and the new configuration is listed under **Mobile**.  
![image-20260123-113617.png](https://docs.leapwork.com/__attachments/a_f8eb3e3ebbf9b7728dd8a5a7b733acbe25151f2e4688a117f8fb75c2d47e2ec5/image-20260123-113617.png?cb=bbbbd62cc4681609402ec4b420d28996)

To edit or delete a configuration, use the **Edit** or **Delete** buttons beside the mobile device entry.  
![image-png-Mar-07-2023-06-21-24-2967-AM.png?width=1077&height=290&name=image-png-Mar-07-2023-06-21-24-2967-AM.png](https://docs.leapwork.com/__attachments/a_3e88de711cc54b19f344926736c106af87e80402ee26531c7d462905c518d79d/image-png-Mar-07-2023-06-21-24-2967-AM.png%3Fwidth=1077&height=290&name=image-png-Mar-07-2023-06-21-24-2967-AM.png?cb=28176d6ed4de6b0e07cb981986f34748)