Note:
Whatfix API access is a prerequisite for sending requests to the Whatfix APIs. To enable Whatfix API access, contact support@whatfix.com.
Whatfix enables you to generate an API Token to authenticate your requests to the Whatfix APIs. Whatfix validates every request with your API token, so you must include it in the request header of each API call. Each Whatfix Dashboard user has a unique API token that identifies the user making the request and determines the actions they can perform on the account.
For example, you can use an API token to bring Mirror analytics data into your own data warehouse or Business Intelligence (BI) tool and report on how your learners perform in Workflows, Assessments, and Roleplays.
Note:
Your account must have Whatfix API access enabled before you can generate an API token.
Use the following steps to generate an API token:
- On the Whatfix Guidance dashboard, click Settings.
Click API token.
Click the Copy icon next to the API token.
Info:
To generate a new API token, click Renew User API Token.
Note:
Keep your API token confidential to prevent unauthorized access to your Whatfix account. Whatfix serves APIs only over HTTPS to protect your token and data during transmission. If your token is exposed, renew it to prevent unauthorized use.
Info:
After you copy the API token, use it to send requests to the Whatfix APIs. For more information, see Developer Guide and API Documentation.