The WalkMe API lets you integrate WalkMe with your internal or third-party systems to automate internal processes.
To get access, contact your account admin to set up your account. Your admin can create users and keys and assign user roles on the Admin page.
The REST API documentation uses Short-Lived Tokens by default. If you're using Personal Access Tokens (PATs), see Personal Access Tokens.
API Base URL
The WalkMe API (v1) is available at: https://api.walkme.com.
- EU data center customers:
https://eu-api.walkme.com - FedRAMP data center customers:
https://api.walkmegov.com - Canada data center customers:
https://api-ca1.walkmedap.com - SAP US data center customers:
https://api-us01.walkme.cloud.sap - SAP EU data center customers:
https://api-eu01.walkme.cloud.sap - SAP CA data center customers:
https://api-ca01.walkme.cloud.sap
Server-Side REST APIs
- User Provisioning API - Provisions and manages WalkMe users
- Multi-Language API - Imports and exports multi-language translation files
- Self-Hosted API - Downloads self hosted files
- Checksum API - Gets the checksum of published content
HTTP Response Codes
| Code | Name | Description |
|---|---|---|
| 200 | Success | Request was successful |
| 201 | Created | Requested resource created |
| 204 | No Content | Request was successful, no content returned |
| 400 | Bad Request | General validation error |
| 401 | Unauthorized | Token is invalid / expired |
| 403 | Forbidden | Token is valid but cannot be used to access the API |
| 404 | Not Found | Response specific to user search, user is not found |
| 409 | Conflict | Resource (user) key is already being used |
| 5xx | Server Error | Server error, contact WalkMe support |