urlscan.io logo urlscan.io
SecurityTrails logo

developer.walkme.com Open in urlscan Pro
2606:4700::6810:f276  Public Scan

Back to summary
Submitted URL: https://walkme-api.readme.io/
Effective URL: https://developer.walkme.com/reference/overview
Submission: On March 20 via api from US — Scanned from US

Form analysis 0 forms found in the DOM

Text Content

Jump to Content

HomeAPI Referencev1.0v2.0

--------------------------------------------------------------------------------

Log In
API Reference
Log In

v2.0
API Reference
Search
CTRL-K
Overview
All
Reference

START TYPING TO SEARCH…

JUMP TOCTRL-/


JAVASCRIPT API

 * Overview
 * Walk-Thrus
 * Smart Walk-Thrus
 * Resources and Surveys
 * Tasks
 * Multi-Language Support
 * Player Menu
 * TeachMe API
   * Player Menu
   * Courses
   * Quizzes
 * Debugging
 * Events
   * WalkMe Ready Event
   * Player Events
   * WalkMe Events
   * Track Custom Events
 * Useful API Commands
   * Troubleshooting Commands
   * ActionBot API Commands


REST API

 * Getting Started
 * Authenticating API Requests
   * Get Authorization Token
 * Systems API
   * Get All Systems
 * User Provisioning API
   * Get All Users
   * Get Single User by User ID
   * Get Single User by Email
   * Create a User
   * Update a User
   * Delete a User
   * Get All Access Roles
   * Get Access Role
 * Multi-Language API V1
   * Import Translation File
   * Export Translation File
   * Create a New Language
   * Get Languages
   * Get Details for a Single Language
   * Update a Language
 * Multi-Language API V2
   * Get Languages List
   * Get Language Details
   * Create a New Language
   * Update a Language
   * Export Translation File
   * Import Translation File
   * Get Job State API
   * Get Asset API
   * Job State Object
   * Export and Import Process
 * Self-Hosted API
   * Export Self-Hosted File
   * Getting the Environment IDs
 * Checksum API
   * Get Checksum of Files
 * Activity Log API
   * Get Account's Activity Log
 * End User Update API
   * Update End User Data
 * Delete End User Data
   * Delete End User Data
 * End User Update API Integration
 * Workstation Notification API
 * Segments API (Beta)
   * Create Segment
   * Update Segment
   * Get Segments


MOBILE

 * Accessing the API
   * Authenticating calls to the API
   * Supported SCIM User attributes
   * Get a list of all users
   * Get details for a single user
   * Create a user
   * Update a user
   * Delete a user
   * Response Headers

JUMP TOCTRL-/


JAVASCRIPT API

 * Overview
 * Walk-Thrus
 * Smart Walk-Thrus
 * Resources and Surveys
 * Tasks
 * Multi-Language Support
 * Player Menu
 * TeachMe API
   * Player Menu
   * Courses
   * Quizzes
 * Debugging
 * Events
   * WalkMe Ready Event
   * Player Events
   * WalkMe Events
   * Track Custom Events
 * Useful API Commands
   * Troubleshooting Commands
   * ActionBot API Commands


REST API

 * Getting Started
 * Authenticating API Requests
   * Get Authorization Token
 * Systems API
   * Get All Systems
 * User Provisioning API
   * Get All Users
   * Get Single User by User ID
   * Get Single User by Email
   * Create a User
   * Update a User
   * Delete a User
   * Get All Access Roles
   * Get Access Role
 * Multi-Language API V1
   * Import Translation File
   * Export Translation File
   * Create a New Language
   * Get Languages
   * Get Details for a Single Language
   * Update a Language
 * Multi-Language API V2
   * Get Languages List
   * Get Language Details
   * Create a New Language
   * Update a Language
   * Export Translation File
   * Import Translation File
   * Get Job State API
   * Get Asset API
   * Job State Object
   * Export and Import Process
 * Self-Hosted API
   * Export Self-Hosted File
   * Getting the Environment IDs
 * Checksum API
   * Get Checksum of Files
 * Activity Log API
   * Get Account's Activity Log
 * End User Update API
   * Update End User Data
 * Delete End User Data
   * Delete End User Data
 * End User Update API Integration
 * Workstation Notification API
 * Segments API (Beta)
   * Create Segment
   * Update Segment
   * Get Segments


MOBILE

 * Accessing the API
   * Authenticating calls to the API
   * Supported SCIM User attributes
   * Get a list of all users
   * Get details for a single user
   * Create a user
   * Update a user
   * Delete a user
   * Response Headers


OVERVIEW

Welcome to the WalkMe Developer Hub!
This Developer Hub has been built by developers for developers,
To provide WalkMe API reference in order to build software alongside WalkMe’s
web platform.

You'll find comprehensive guides and documentation,
To help you start working with WalkMe API as quickly as possible,
As well as support if you get stuck. Let's jump right in!


> 👍
> 
> A NEW REQUEST? NEEDS CHANGES?
> 
> Any new API you think is necessary, or any changes you think should be made to
> the APIs we already have, please contact us.

A common use case for using WalkMe API,
Is to start a specific WalkMe items via an interaction with a specific element
on your page.
In order to start any content, you will need to provide the correct Id.


FINDING THE ID OF WALKME CONTENT

The IDs can be found by following these steps in the WalkMe Editor:

1. Select the type of WalkMe content you want to start (Smart Walk-Thrus,
Resources, Surveys, etc)
2. Hover over the desired item
3. Hover over the pencil icon
4. Click "Copy ID"

Alternatively, some IDs can be found using the WalkMe API, for example:
WalkMeAPI.getWalkthrus()

Updated 9 months ago

--------------------------------------------------------------------------------

Walk-Thrus

Updated 9 months ago

--------------------------------------------------------------------------------

Walk-Thrus
 * Table of Contents
 * * Finding the ID of WalkMe Content



 1.  Javascript API
 2.  Overview
 3.  Walk-Thrus
 4.  Smart Walk-Thrus
 5.  Resources and Surveys
 6.  Tasks
 7.  Multi-Language Support
 8.  Player Menu
 9.  TeachMe API
 10. Quizzes
 11. Courses
 12. Player Menu
 13. Debugging
 14. Events
 15. Track Custom Events
 16. WalkMe Events
 17. Player Events
 18. WalkMe Ready Event
 19. Useful API Commands
 20. ActionBot API Commands
 21. Troubleshooting Commands

 1.  REST API
 2.  Getting Started
 3.  Authenticating API Requests
 4.  Get Authorization Token
 5.  Systems API
 6.  Get All Systems
 7.  User Provisioning API
 8.  Get Access Role
 9.  Get All Access Roles
 10. Delete a User
 11. Update a User
 12. Create a User
 13. Get Single User by Email
 14. Get Single User by User ID
 15. Get All Users
 16. Multi-Language API V1
 17. Update a Language
 18. Get Details for a Single Language
 19. Get Languages
 20. Create a New Language
 21. Export Translation File
 22. Import Translation File
 23. Multi-Language API V2
 24. Export and Import Process
 25. Job State Object
 26. Get Asset API
 27. Get Job State API
 28. Import Translation File
 29. Export Translation File
 30. Update a Language
 31. Create a New Language
 32. Get Language Details
 33. Get Languages List
 34. Self-Hosted API
 35. Getting the Environment IDs
 36. Export Self-Hosted File
 37. Checksum API
 38. Get Checksum of Files
 39. Activity Log API
 40. Get Account's Activity Log
 41. End User Update API
 42. Update End User Data
 43. Delete End User Data
 44. Delete End User Data
 45. End User Update API Integration
 46. Workstation Notification API
 47. Segments API (Beta)
 48. Get Segments
 49. Update Segment
 50. Create Segment

 1.  Mobile
 2.  Accessing the API
 3.  Response Headers
 4.  Delete a user
 5.  Update a user
 6.  Create a user
 7.  Get details for a single user
 8.  Get a list of all users
 9.  Supported SCIM User attributes
 10. Authenticating calls to the API


 1.  Javascript API
 2.  Overview
 3.  Walk-Thrus
 4.  Smart Walk-Thrus
 5.  Resources and Surveys
 6.  Tasks
 7.  Multi-Language Support
 8.  Player Menu
 9.  TeachMe API
 10. Quizzes
 11. Courses
 12. Player Menu
 13. Debugging
 14. Events
 15. Track Custom Events
 16. WalkMe Events
 17. Player Events
 18. WalkMe Ready Event
 19. Useful API Commands
 20. ActionBot API Commands
 21. Troubleshooting Commands

 1.  REST API
 2.  Getting Started
 3.  Authenticating API Requests
 4.  Get Authorization Token
 5.  Systems API
 6.  Get All Systems
 7.  User Provisioning API
 8.  Get Access Role
 9.  Get All Access Roles
 10. Delete a User
 11. Update a User
 12. Create a User
 13. Get Single User by Email
 14. Get Single User by User ID
 15. Get All Users
 16. Multi-Language API V1
 17. Update a Language
 18. Get Details for a Single Language
 19. Get Languages
 20. Create a New Language
 21. Export Translation File
 22. Import Translation File
 23. Multi-Language API V2
 24. Export and Import Process
 25. Job State Object
 26. Get Asset API
 27. Get Job State API
 28. Import Translation File
 29. Export Translation File
 30. Update a Language
 31. Create a New Language
 32. Get Language Details
 33. Get Languages List
 34. Self-Hosted API
 35. Getting the Environment IDs
 36. Export Self-Hosted File
 37. Checksum API
 38. Get Checksum of Files
 39. Activity Log API
 40. Get Account's Activity Log
 41. End User Update API
 42. Update End User Data
 43. Delete End User Data
 44. Delete End User Data
 45. End User Update API Integration
 46. Workstation Notification API
 47. Segments API (Beta)
 48. Get Segments
 49. Update Segment
 50. Create Segment

 1.  Mobile
 2.  Accessing the API
 3.  Response Headers
 4.  Delete a user
 5.  Update a user
 6.  Create a user
 7.  Get details for a single user
 8.  Get a list of all users
 9.  Supported SCIM User attributes
 10. Authenticating calls to the API