Betterworks API

Avatar
by The Betterworks Team
Follow
Recommended Reader(s): Super Admins

What does it do?

The Betterworks REST API allows applications to programmatically access and update data within Betterworks. You can automatically update progress on goals, plus easily retrieve goal and employee data.

  • Employee Data: Access all employee data, including progress and alignment on goals.
  • Goal Data: See the entire goal history including assessments and comments. Easily import this information into your HRIS system.
  • Progress Automation: Automatically update goal data in real-time when progress is made or a goal is completed from any application.

Where can I learn more about this?

You can learn more about this via:

API Key Access

Note: If you do not want to link an API key to an actual employee, you can create a fictitious user in the "Manage Departments and Users" section of the admin portal. You can name the user with a description of the application using the API key (e.g., First Name: Reporting Application).

Any application can use the API as long as every request to the API has an active API key.  

API keys are tied to activated users in Betterworks. The data available to the application is based on the permissions of the user. Below are the steps to generate an API key:

  • Navigate to the Betterworks API page by going to Admin > Platform configuration > Betterworks API
  • Search for a user to link an API key to. The data available to the application using the API key will be based on the selected user.
  • Assign the API key a unique name. The same user can have multiple keys.
  • Click "Generate Key"
  • The API key will be generated and will be shown under "Active Keys". The key will need to be included in every API call to the Betterworks platform.

Revoking a Key

An API key can be revoked at any time.

  • Navigate to the Betterworks API page by going to Admin > Platform configuration > Betterworks API
  • Click "Revoke" for the API key you wish to revoke in "Active keys"
  • The API key will be immediately deactivated
  • The API key can be reactivated at any time by clicking "Reactivate" in "Deactivated keys"