When setting up workflows for the Workleap API or Officevibe API, you must create an API key in Workleap Settings for authentication. You can view, edit, or revoke existing API keys as well as create new API keys from the API management page in Workleap Settings.
Create an API key
To create a new API key:
Log in to Workleap and open Settings.
Select API from the side menu under Integrations.
Select Create API key.
Set a scope for the API key.
Choose between:
Workleap API only.
Officevibe API only.
Global (works interchangeably between all our APIs).
Choose an access level between:
Read and write.
Read only.
Select Create API key to generate the key.
Important: The full API key is only shown once at the time of creation and cannot be recovered if you lose access to it. If you lose a key, revoke it and create a new key.
Tip: If you are unsure of the access level required for the endpoints you want to use, check our API docs.
Manage API keys
Find all API keys in a list on the API management page (Settings > API). Here, you can view all of your organization's API keys, including their scope, access level, expiry date, and status. You can also edit or revoke API keys from the list.
Edit an API key
To edit an API key's scope or access level:
Log in to Workleap and open Settings.
Select API from the side menu under Integrations.
Select the ellipsis (...) next to the API key you want to edit, and then select Edit API key.
Update the API key's scope or access level as needed, and then select Update key to confirm.
Revoke an API key
To revoke an API key:
Log in to Workleap and open Settings.
Select API from the side menu under Integrations.
Select the ellipsis (...) next to the API key you want to edit, and then select Revoke API key.
Select Revoke permanently to confirm.
Once revoked, API keys are removed from the API management list.