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()