27min

Zenefits

ļ»æļ»æļ»æļ»æThis app will sync your worker data from Zenefits automatically on a daily basis. The following information is included:

  • Contact info (emails, phones, addresses)
  • Demographic info (gender, birthdates)
  • Compensation
  • Managers
  • Departments, Locations, Bands

Setting up the Zenefits payroll app

Obtaining API credentials

To get started, you will need to obtain API access from Zenefits. You'll need to obtain an API key by following the steps below.

  1. Open Zenefits.
  2. Go to theĀ CustomĀ IntegrationsĀ option from theĀ Company Profile.
  3. Click onĀ Add Token.
  4. Select the scopes that include employment and personal data.Ā 
  5. ClickĀ Save.
  6. Click the "eye" icon to unmask the token and copy the token. (Save this code somewhere safe, you'll need this later!)

Once you've copied the necessary information from Zenefits, do not share this information with anyone outside of your organization, as it enables direct access to your data within Zenefits.

Installing Zenefits in ChartHop

In order to use the API credentials you gathered above, you'll need to install the Zenefits app in ChartHop. To install the Zenefits app, simply

  1. Navigate to Apps and Integrations in ChartHop,
  2. Find Zenefits in the list of available apps,
  3. Click Install on the far right-hand side of the table.

Entering Zenefits API credentials, and other config settings

In order for ChartHop to access your Zenefits data, you'll need to enter the Zenefits API credentials you obtained above. In addition, there are a number of other configuration settings available to you.

Field

Description

API Key

This is the API key copied from Zenefits. This field is required.

Run Daily

With this option selected, the sync will run automatically every day.

Send Notification Email To

These users will be emailed every time a sync occurs with a summary of the changes.

For advanced config options, see Advanced options for payroll apps on the Get started with payroll apps page.

Please don't hesitate to contact implementation@charthop.com if you need assistance.

Syncing data from Zenefits

Understanding synced data

Once the Zenefits payroll app has been properly set up, ChartHop will be able to pull Zenefits data into your ChartHop account.

The table below lists all fields that are synced from Zenefits to ChartHop during a sync. In the first column, we list the name of the field in ChartHop, and in the second column, we list the name of the field in Zenefits.

ChartHop field

Zenefits field

Transform type

address.city

profiles.city

one-to-one

address.country

profiles.country

one-to-one

address.postal

profiles.postal_code

one-to-one

address.state

profiles.state

one-to-one

address.street1

profiles.street1

one-to-one

address.street2

profiles.street2

one-to-one

birthdate

profiles.date_of_birth

one-to-one

contact.homeemail

profiles.personal_email

one-to-one

contact.mobilephone

profiles.personal_phone

one-to-one

contact.workemail

profiles.work_email

one-to-one

contact.workphone

profiles.work_phone

one-to-one

currency, base, hourly

profiles.employments.data[0].amount_type, profiles.employments.data[0].comp_type, profiles.employments.data[0].annual_salary, profiles.employments.data[0].pay_rate

transform

date

timeOff.created_date

one-to-one

depart

profiles.employments.data[0].termination_type

map-one-to-one

department

profiles.department.url, departments.ids

transform

employment

profiles.employments.data[0].employment_type

one-to-one

gender

profiles.gender

one-to-one

imageurl

profiles.photo_url

one-to-one

location

profiles.location.url, locations.ids

transform

manager

profiles.manager.url

transform

name.first

profiles.first_name

one-to-one

name.last

profiles.last_name

one-to-one

name.middle

profiles.middle_name

one-to-one

name.pref

profiles.preferred_name

one-to-one

timeoff.approval

timeOff.status

map-one-to-one

timeoff.days, timeoff.hours

timeOff.hours

transform

timeoff.enddate

timeOff.end_date

one-to-one

timeoff.id

timeOff.id

one-to-one

timeoff.note

timeOff.reason

one-to-one

timeoff.startdate

timeOff.start_date

one-to-one

timeoff.type

timeOff.vacation_type.url, vacations.ids

transform

title

profiles.title

one-to-one

type, date, startdate, enddate

profiles.employments.data[0].hire_date, profiles.employments.data[0].termination_date

transform

Transform Type refers to the logic employed when copying data from the source field to the target field. In many cases, one-to-one logic is employed, where the value in the source field is copied to the target field exactly as it is. In some cases, many-to-one or transform are listed, which indicates that the logic is more complex.

Running a single, on-demand sync from Zenefits

Any ChartHop user with sufficient permissions can trigger an on-demand sync from Zenefits at any time. To sync your data for the first time, or subsequently on-demand at any time, follow the steps below.

  1. Open ChartHop.
  2. Select the gear icon.
  3. Select Apps and Integrations.
  4. Find and select Zenefits.
  5. Scroll down to the bottom of the page, and click on Sync To Primary.

Upon clicking Sync to Primary, ChartHop will pull all of your org's current employee data from Zenefits. Once completed, you will see a message indicating that the sync has been completed.

Permissions

To sync your Zenefits data into ChartHop, your ChartHop user must have an access level of at least aĀ Technical Owner. If you are not a Technical Owner and believe you should be, please contactĀ support@charthop.com.

Running a daily, automated sync from Zenefits

Any ChartHop user with sufficient permissions can set up an automated sync from Zenefits at any time. To set up an automated sync, follow the steps below.

  1. Open ChartHop.
  2. Select the gear icon.
  3. Select Apps and Integrations.
  4. Find and select Zenefits.
  5. Scroll down to the bottom of the page, and click on Run Daily.
  6. Click Save Settings when you are done.

ļ»æ