Desktop SDK with Windows

Updated on May 28, 2019 Download PDFDownload as PDF
Download PDF

Brief Overview

The WalkMe for Desktop Windows SDK solution targets applications that are distributed by the application developer (i.e., organizations that have access to the source code of the application).

Steps for Integration

Loading the WalkMe SDK:

  1. Get WalkMe SDK files from WalkMe
  2. Include in code the SDK supplied header file.
  3. Call the exported function Walkme.start(scriptUrl , <options>)
    • scriptUrl is an address that will be provided from WalkMe
    • options is an optional parameter that set the WalkMe configuration (e.g enable/disable Analytics, Language, etc).
  4. Build the target application and link with the SDK supplied lib file.

SDK Specification

UI Content

The WalkMe for Windows SDK UI content allows users to create and launch guidance content through the Walkme Editor directly to the app. The SDK is responsible for displaying and managing the content, whether in-app ShoutOuts or Walk-Thrus of various types.


Customers can use the WalkMe SDK API to control the Walkme SDK programmatically.


WalkMe SDK collects user-interaction information and analyzes the end-user behavior within a given app, and that app only. No data is merged with other applications from the same customer or from other customers.

WalkMe’s SDK does not collect any personally identifiable information (“PII”) by default. All the information is stored under a self-created globally unique identifier (“GUID”) and is focused on behavior analysis within the app, not on the app’s content.

Supported Development Environments

The WalkMe SDK is compatible with QT, Java or any other technology used for building Windows OS apps.

External Dependencies

The WalkMe SDK uses external libraries:

  • QT dlls (for client and editor mode)
  • SocketIoClientDotNet (only for editor mode)


The WalkMe SDK works on native desktop apps with certain constraints.

  • Supported Operating Systems (Minimum Version): Windows 7 SP1 and higher with .NET framework 4.6.1. (Note: Windows 10 natively supports .NET 4.6.1 since the November 2015 update.)
  • Hardware Requirements: 2.0 GHz or faster processor, 2.0GB RAM or higher.


  • Installation file size: 8MB
  • Size (after installation): Installation file size (MSI): 16MB (Net Walkme software, without .NET environment)


The WalkMe SDK is designed and built to run with the smallest footprint possible.

The WalkMe SDK should not affect app performance, as it uses low-level native OS APIs to optimize its performance.


WalkMe for Windows Desktop is designed and built to run with as minimal a footprint as possible. In a benchmark on a machine with i5 4 cores (i5-2450 2.5GHz) the average CPU was measured over time during idle and active state on WalkMe and the Plugin. The idle state is defined as a scenario when no interaction with WalkMe occurred. The active state is defined as a scenario when a WalkMe Smart Walk-Thru is running and a user is interacting with WalkMe.




Was this article helpful?

Related Articles

< Back