Workstream Public APIs allow seamless integration with your company’s data, enabling efficient communication between different software systems.
These APIs use OAuth 2.0 for secure access, ensuring that only authorized users can retrieve or manage data. Super Admins have exclusive permissions to add integrations and generate access tokens, which are required for authentication.
📌 Each access token is valid for seven (7) days, after which a new token must be created or refreshed to maintain connectivity. This setup ensures controlled and secure API usage while facilitating streamlined data management within Workstream.
⚠️ Things to remember:
Only Super Admins have permission to add and manage integrations in Workstream. If you need access, please contact your admin for assistance.
To enable the OAuth App module, reach out to Workstream support at help@workstream.is. Once activated, Super Admins can generate API tokens for developers to integrate with Workstream.
Located in Admin view > Integrations > Access Token, you can generate your access tokens here.
Create an access token
On Admin View, go to Company Settings → Integrations.
On the left panel, choose Access Token. Click on the Create access token button. A pop-up should appear.
In the Create token pop-up,
(Required) Name your access token.
(Required) Choose the data access this token will have.
Once done, click Create.
After clicking Create, a confirmation message will appear containing your Access token. Copy this token by clicking on the Copy token button and save this token somewhere secure.
Refresh an access token
On Admin View, go to Company Settings → Integrations.
On the left panel, choose Access Token.
Click on the three-dot menu (•••) beside the token/s you wish to refresh then click Refresh Token.
A confirmation asking you to confirm the token refresh. Click Refresh.
Note: Any applications or scripts using the token you're refreshing will be impacted.After refreshing, the confirmation message will appear containing your Access token. Copy this token by clicking on the Copy token button and save this token somewhere secure.
Edit an access token
On Admin View, go to Company Settings → Integrations.
On the left panel, choose Access Token.
Click on the three-dot menu (•••) beside the token/s you wish to edit then click Edit. A pop up should appear.
Choose the Data accesses you wish you add or remove for the Token. Once done, click Save.
Delete an access token
On Admin View, go to Company Settings → Integrations.
On the left panel, choose Access Token.
Click on the three-dot menu (•••) beside the token/s you wish to edit then click Delete. A pop up should appear asking you to confirm the deletion.
If decision is final, click Delete.