Whatfix is a digital adoption platform providing in-app contextual guidance, SaaS management, workflow automation, and product analytics to help organizations accelerate software adoption, improve employee onboarding, and optimize digital transformation. Its platform combines guided walkthroughs, self-help content, AI-powered authoring agents, task lists, surveys, and usage analytics for web, desktop, mobile, and VDI environments.
Website: https://whatfix.com
The Whatfix REST API enables programmatic access to end-user management, content management, flow analytics, segmentation, and report downloads. The API is stateless, uses JSON output, and authenticates via the x-whatfix-integration-key header.
- Developer Portal: https://developer.whatfix.com
- Developer Guide: https://support.whatfix.com/docs/developer-guide
- Authentication: https://support.whatfix.com/docs/generatingtheapitoken
- Base URL: https://whatfix.com/api/v1
- Android SDK: https://github.com/whatfix/whatfix-android — DAP solution for native Android apps
- iOS SDK: https://github.com/whatfix/Whatfix-iOS — DAP solution for native iOS apps
| Spec | Description |
|---|---|
| Whatfix API | REST API covering end users, content, analytics, segments, and reports |
| Example | Description |
|---|---|
| List End Users | List all tracked end users with pagination |
| Get Flow Analytics | Get flow views and completion rates for a date range |
| Upsert End User | Create or update an end user with segmentation attributes |
| List Content | List all published flows and content items |
- whatfix-rules.yml — Spectral ruleset enforcing Whatfix API conventions
| Capability | Description |
|---|---|
| digital-adoption.yaml | Unified digital adoption monitoring — end users, content, analytics, segmentation (9 tools) |
| File | API |
|---|---|
| shared/whatfix-api.yaml | Whatfix REST API v1 |
| Schema | Description |
|---|---|
| Whatfix End User | End user for analytics and segmentation |
| Whatfix Content | Content items including flows, tooltips, task lists |
| Structure | Description |
|---|---|
| Whatfix End User | End user structure |
| Whatfix Content | Content item structure |
- whatfix-context.jsonld — Linked data context for digital adoption platform vocabulary
- whatfix-vocabulary.yml — Domain vocabulary for digital adoption, content types, segmentation, and analytics
| Type | URL |
|---|---|
| Website | https://whatfix.com |
| Developer Portal | https://developer.whatfix.com |
| Documentation | https://support.whatfix.com |
| GitHub Organization | https://github.com/whatfix |
| Blog | https://whatfix.com/blog/ |
| Pricing | https://whatfix.com/pricing/ |
| Integrations | https://whatfix.com/integrations/ |
Maintainer: Kin Lane (kin@apievangelist.com)