Prerequisites
Before getting started, please carefully read the following to make sure you fulfill all requirements for the integration to work:
You are an admin of your HRworks instance or an admin shared their access with you. This is necessary for retrieving the API credentials as explained later in this guide
1. Log into your company's HRworks instance, and navigate to the top right of your screen.
2. Click on your profile picture.
3. You should be able to see the "Switch to admin interface" tab. If you cannot see it, it means that you are not an admin in your company's HRworks instance:
Find your API credentials
Log into your HRworks instance (or that of the admin account that was shared with you)
On the sidebar, click on the "Basics" dropdown
In the options that just appeared, click on "Integrations"
Click on the tile "HR WORKS-API"
On the new page, click the button "New key pair"
Click the button "Download" that just appeared
Your API credentials should have been downloaded by now as a .txt file
Open the file.
You should see the credentials in the format ofAccess Key: bwdJ9...........kRhc Secret Access Key: XNN73f3/P.......................U9DoOnB6
For security reasons parts of these credentials were redacted, real credentials have no "..." in them
Enter the credentials into the connection flow, and press continue
Next, please make sure you have the right scopes selected for this integration.
The connection flow will display the required scopes
Now, in HRworks, select the key you just generated and check the required permissions at the bottom of the page, and press save
This is just an example, your required scopes might look different!
Finally, click "Set up integration" in the connection flow