This article applies specifically to organizations using the HRIS Sync integration.
Overview
This guide will walk you through retrieving your Client ID and Secret in Charlie to complete your linking flow
Prerequisites
Please ensure you fulfill all the requirements to set up the integration:
- You are an Administrator in your company's Charlie instance, or someone has shared their access with you.
Video Demo
Instructions
Step 1: Accessing your Client ID and Secret
- Click on Integrations in the left-hand corner
- Click on API Keys to navigate to the Client ID and Secret that you'll need to populate within the linking flow
- Generate the Client ID and Client Secret for your CharlieHR account
IMPORTANT: Please copy and safely store both the Client ID and Client Secret from the above page
If you've already generated a Client ID and Secret in the past, you will need to retrieve your Client Secret from your HR or IT team.
Step 2: Copy and paste the Client ID and Secret into the linking flow
Fields ContactMonkey can sync from Charlie
When you connect Charlie with HRIS Sync, ContactMonkey can pull the fields below into your Directory. A field only fills in if it has a value in Charlie 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. |
| 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. |
| Manager | The employee's manager. |
| Groups | The departments, teams and other groups the employee belongs to. See Group fields below. |
| Work location | The employee's work address. See Location fields below. |
| 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. |
| Marital status | The employee's filing status as related to marital status. |
| Social security number | The employee's social security number. |
Group fields
Groups are how Charlie organizes employees, such as departments and teams.
| Field | What it contains |
|---|---|
| Group name | The name of the department, team or other group. |
| Group type | The kind of group as labelled in your HRIS, such as department, team, cost center or business unit. |
Location fields
Location fields describe an employee's addresses.
| 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. |
| State or region | The state, province or region. |
| 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 Charlie
Charlie doesn't share these fields through HRIS Sync: Preferred first name, Username, Employee number, Record created date, Ethnicity, Parent group.