Desktop SDK with Mac

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

Brief Overview

The procedure of embedding the WalkMe for Desktop Mac SDK as well as additional technical information regarding the WalkMe for Desktop SDK.

Use Cases

WalkMe’s solutions allow user engagement based on business goals and guidance based on user needs.

  • Shorten system integration and ensure a fast return on investment
  • Reduce support costs to a minimum and foster a culture of self-reliance
  • Replace training with immediate productivity and close the skill gap
  • Increase employee throughput and eliminate user errors
  • Optimize clickstreams and increase customer goal completion rates and conversions

WalkMe Modules

Editor (Authoring/Admin Tool)

The WalkMe Editor is the central authoring and management tool used to create, maintain and deploy WalkMe’s interactive components to digital platforms such as consumer applications and enterprise management systems. WalkMe’s Editor is an Electron-based cross-platform desktop application for Windows and Mac OS. The Editor captures elements’ metadata and associates them with WalkMe’s interactive components.

Once published, the Editor generates static files hosted on WalkMe’s Amazon Cloud and distributed through WalkMe’s Akamai CDN for rapid access.

The Editor works on Windows (Version 7 and above) and Mac OS (Version 10.9 and above). It runs in conjunction with desktop applications and communicates with them via WebSocket.


Electron is a framework that packages JS, HTML, and CSS into cross-platform desktop apps.

Player (SDK Client)

The WalkMe Player is an independent software module that overlays WalkMe’s interactive components on top of desktop applications, and embeds WalkMe’s interactive components into digital platforms such as enterprise management systems and consumer applications.

WalkMe’s Player points to the Data files containing WalkMe’s elements and their configurations, which are then downloaded from the Akamai CDN. Once downloaded, the data files are stored in the SDK cache, and are downloaded again only if changes were detected, ensuring minimal bandwidth overhead.

Scope of Solution

The WalkMe for Desktop MAC solution targets native and hybrid MAC OS applications that are distributed by the application developer (i.e., organizations that have access to the source code of the application).

Application + SDK


Steps for Integration

  1. Create a PodFile;
    • If this is the first Pod in your project, create an empty file called Podfile: 
  2. Determine which of the below circumstances applies to you:
    1. Target ‘YourTarget’
    2. Execute  pod
      • pod ‘WalkMe’  for end users
      • pod  ‘WalkMeEditor’ for content builders
    • If you already have a Podfile, add the following line to the HEAD of your file and save it as pod ‘walkmeForMac’;
    • If you’re starting a new Podfile, add the following three lines:
  3. In order to install a specific version use this line:
  4. Close your project;
  5. Open the terminal pointing to your project’s root and run the following command:
    Pod install
  6. After installation, add the following to your AppDelegate.m:
    #import <WalkMe/WalkMe.h>
  7. In – (void)applicationDidFinishLaunching:(UIApplication *)application; Add the following:
    • [WalkMe start:@”YOUR_WM_SCRIPT_URL”];
  8. Verify the integration by looking for this line in your logs: WalkMe_SDK



Was this article helpful?

Related Articles

< Back