This article applies specifically to organizations using the HRIS Sync integration.
Overview
To authenticate Deel, you will need to provide the following information:
- Organization Token
Prerequisites
- You must be a Deel admin to complete the linking flow
- Your Deel account must have API access enabled. Contact your Deel account manager to confirm if you are unsure of this
Instructions
Step 1: Create an organization token
- In your Deel portal, go to Developer Center in the drop-down menu from the top bar
- Click Generate new token
- Label your token, choose Organization token (Recommended), and click Next
- Select all scopes to add to your organization token and click Generate
Step 2: Enter your token in the linking flow in ContactMonkey
- Click Directory at the top of the ContactMonkey dashboard
- Select Sources
- Find the HRIS Sync tile and click Configure. Search for Deel in the pop-up modal, follow the steps, and enter your token.
Fields ContactMonkey can sync from Deel
When you connect Deel with HRIS Sync, ContactMonkey can pull the fields below into your Directory. A field only fills in if it has a value in Deel 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. |
| Username | The employee's username in your HRIS. |
| 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. |
| Record created date | When the employee's record was created in your HRIS. |
| 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. |
Group fields
Groups are how Deel 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. |
| City | The city. |
| State or region | The state, province or region. |
| Zip or postal code | The zip or postal code. |
| Country | The country. |
Fields not available from Deel
Deel doesn't share these fields through HRIS Sync: Preferred first name, Mobile phone number, Profile photo, Employee number, Gender, Ethnicity, Marital status, Social security number, Parent group, Street address line 2, Location phone number.