This article applies specifically to organizations using the HRIS Sync integration.
Overview
To authenticate ChartHop, you will need to provide the following information:
- ChartHop subdomain
- API key
This guide will walk you through finding or creating those credentials within ChartHop.
Prerequisites
Please ensure you have Admin permissions in your company's ChartHop instance or someone has shared their access with you.
Instructions
Step 1: Locate your ChartHop subdomain
If your ChartHop URL is https://app.charthop.com/acme/home, add acme
Step 2: Find your ChartHop API key
- Go to Settings → Apps → All apps. Install the Merge app.
- Generate an API Token with the Access Level "Owner."
- Save the API Token
Step 3: Enter your API key into the linking flow
Fields ContactMonkey can sync from ChartHop
When you connect ChartHop with HRIS Sync, ContactMonkey can pull the fields below into your Directory. A field only fills in if it has a value in ChartHop 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. |
| Preferred first name | The first name the employee prefers to go by. |
| Full name | The employee's full name. Uses the preferred first name when one is available. |
| Work email | The employee's work email address. |
| Personal email | The employee's personal email address. |
| Mobile phone number | The employee's mobile phone number. |
| Profile photo | A link to the employee's profile photo. |
| 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. |
| Home address | The employee's home address. See Location fields below. |
| Date of birth | The employee's date of birth. |
| Gender | The employee's gender. |
| Ethnicity | The employee's ethnicity. |
Location fields
ChartHop shares home addresses only. Work addresses aren't available.
| Field | What it contains |
|---|---|
| Location name | The name of the location. |
| Location type | Whether the address is a work or home address. |
| Street address line 1 | Line 1 of the street address. |
| Street address line 2 | Line 2 of the street address. |
| City | The city. |
| Zip or postal code | The zip or postal code. |
| Country | The country. |
| Location phone number | The phone number for the location. |
Fields not available from ChartHop
ChartHop doesn't share these fields through HRIS Sync: Username, Employee number, Record created date, Manager, Groups, Work location, Marital status, Social security number, State or region.