This article applies specifically to organizations using the HRIS Sync integration.
Overview
This guide will walk you through creating an API key within HR Partner and entering it into the linking flow
Prerequisites
Please ensure you fulfill all the requirements to set up the integration:
- You are an Admin in your company's HR Partner instance
Instructions
Step 1: Finding your HR Partner API Key
- Log in to your HR Partner as an admin for your organization, and click on the Setup button on the left navigation bar. Once the Setup menu is expanded, go to Configure and click Integrations
- At the top of the Integrations page, you'll see your settings. Make sure that Enable API Access for external applications is checked
- Copy the API Token
Step 2: Enter your API Key into the linking flow
Fields ContactMonkey can sync from HR Partner
When you connect HR Partner with HRIS Sync, ContactMonkey can pull the fields below into your Directory. A field only fills in if it has a value in HR Partner and the account you used to connect has permission to read it.
Employee fields
| Field | What it contains |
|---|---|
| First name | The employee's first name. |
| Last name | The employee's last name. |
| Full name | The employee's full name. Uses the preferred first name when one is available. |
| Work email | The employee's work email address. |
| Employment status | Whether the employee is active, pending or inactive. |
| Start date | The date the employee started. For rehired employees, this is the most recent start date. |
| Termination date | The employee's termination date. |
| Date of birth | The employee's date of birth. |
| Gender | The employee's gender. |
Fields not available from HR Partner
HR Partner doesn't share these fields through HRIS Sync: Preferred first name, Personal email, Mobile phone number, Profile photo, Username, Employee number, Record created date, Manager, Groups, Work location, Home address, Ethnicity, Marital status, Social security number.