Creating a Workvivo API bearer token
Every request to the Workvivo API must include a bearer token in its authorization header. This article explains how to create an app, assign the required scopes, and generate a bearer token.
- Create an app in Workvivo.
- Assign the permissions and scopes required by your integration.
- Generate and securely store a bearer token.
Requirements
Device: Desktop
Role: Developer
Availability: API access must be enabled by Workvivo Support.
- Contact Workvivo Support to request API access for your organisation.
- After API access is enabled, an account administrator must grant the user the Developer role. See Granting roles in Workvivo.
Users with the Developer role can access API Keys and JWT Settings from the Administration menu. From there, they can create apps, manage integration scopes, and generate bearer tokens.
Create an app and generate a token
1. Open API Keys and JWT Settings
Open Administration, then select API Keys and JWT Settings.
2. Add an app
Select Add New App.
3. Name the app and assign scopes
Enter a clear name for the app and select the permissions required by your integration. Review the API documentation to identify the scopes required for each endpoint. For example, an integration using the Teams API must have the relevant Teams read or write scopes.
Tip: You can update the app’s scopes later if your requirements change.
4. Manage the app’s keys
After creating the app, select Manage Keys.
5. Generate a bearer token
Select Add New Key, then enter a name for the key. Workvivo will generate and display the bearer token.
Important: Copy the token and store it securely before closing the window. The token cannot be retrieved again after the window is closed.
If a token is exposed or may have been compromised, delete its key immediately and generate a replacement.
Additional information
- See the Workvivo Developer documentation for available endpoints and required scopes.
- API access is not enabled for every Workvivo account. Contact Workvivo Support if you need access.