What is the Snippet?
Where is the Snippet?
- Open the WalkMe Editor.
- Log In.
- Click Publish in the blue admin bar.
- Open the Snippet tab.
- Select an environment.
- Each environment has a slightly different snippet code. If you have a test/sandbox/staging site, copy the snippet for Test. If you would like the snippet for publishing to your end-users, copy the snippet for Production.
- Copy the snippet code:
How Do I Deploy the Snippet?
The snippet can either be pasted into the HTML head tag of your website or injected by a browser extension.
Deployment option 1: Paste the snippet into your HTML
If you are able to modify the HTML of the website, you can paste the WalkMe snippet into the <head> tags of the pages on which you want WalkMe to appear. With the snippet in place, WalkMe will be available to all users on every page-load. This is the preferred option for external-facing applications, because end-users do not need to download or install anything for WalkMe to appear.
To deploy the snippet, simply copy the snippet from your WalkMe Editor account and then paste this code between the head tags in your site or application.
Deployment option 2: The WalkMe Extension
If you are publishing WalkMe on a site for which you do not have access or permission to modify the HTML, your Customer Success Manager will help you deploy a WalkMe Player extension. End-users will be able to access WalkMe if they have the extension enabled.
Deploying an extension is generally the preferred option for applications used by internal staff such as CRMs (such as Salesforce), HRMs (such as SuccessFactors or Workday), or Intranet systems.
The WalkMe extension can be enabled via Mass Installation (your site administrator deploys the snippet to all users across your network) or Manual Installation (ask users to download the extension themselves).
We recommend deploying the extension via Mass Installation. Mass Installation is easily implemented and controlled by your IT Admins and requires no action from end-users. Contact your Customer Success Manager for simple, easy-to-follow directions. More information for your IT team about Mass Installation.
When Mass Installation is not an option, users may manually install the extension. To manually install the extension, your Customer Success Manager will provide you with a unique URL to give to your users that will bring them to extension installation page. This link can be shared with users in an email or for some sites you may be able to be add a Download Now button in the app itself.
Note on Extension installation on Safari browser:
For both mass and manual installation of the Extension on the Safari browser, the end-user should select the highlighted button “Install from Gallery” in order to enable the Extension to auto-update (if the user selects “Install from Developer” the Extension will not be updated automatically):
How do I Test that the Snippet is Working?
Once the snippet is in place, you will be able to see your published content from the Editor. To test the snippet to make sure it’s set up correctly:
- Open your site
- Right click and select inspect the page
- Open the console
- Enter the following text query: _walkMe.getEnvId()
- If it returns undefined, the Snippet is not properly set up. If the query returns a value, then you’re all set!
If you have a Test site, you may choose to first publish your WalkMe items to this site before publishing to your end users on your Production site. The Snippet is slightly different for each environment. Since the Snippet is different for each environment, you will need to deploy it separately for each environment.
Deploy the Test Snippet for your Test (or Sandbox or Staging) site; then items published to Test will appear on your Test site. Similarly, deploy the Production Snippet for your site; then items published to Production will appear on your Production site.