24min

Rippling (legacy)

Packages:  Basic | Standard | Premium

This app will sync your organizational roster from Rippling automatically on a daily basis. The following information is included:

  • Title, manager, department, location
  • Hires and departures
  • Personal contact and demographic information
  • Compensation changes

This app has been deprecated as of August 2022. Integrations after that date should use the newer version of this app. Learn more.

Setting up the Rippling payroll app

Obtaining API credentials

Rippling will soon require customers to pay for API access. They'll allow existing API keys to remain intact, but going forward, will charge to generate new API keys. Customers interested in this integration should be aware of the incurred additional cost of using the Rippling app.

To get started, you will need to obtain API access from the Rippling settings by following the steps below.

  1. Open Rippling.
  2. Under the Main Menu, click on Company Settings
  3. Generate a Personal Access Token and save the code somewhere safe (you'll need this later).

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

Installing Rippling in ChartHop

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

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

Entering Rippling API credentials, and other config settings

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

Field

Description

Personal Access Token

The access token copied above. This field is required.

Name of Org Head

Enter the name of your CEO or the org head of your Rippling instance. 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 Rippling

Understanding synced data

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

The table below lists all fields that are synced from Rippling 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 Rippling.

ChartHop field

Rippling field

Transform type

address.city

profiles.address.city

one-to-one

address.country

profiles.address.country

one-to-one

address.postal

profiles.address.zip

one-to-one

address.state

profiles.address.state

one-to-one

address.street1

profiles.address.streetLine1

one-to-one

address.street2

profiles.address.streetLine2

one-to-one

base, hourly, currency

profiles.compensation.salaryUnit, profiles.compensation.salaryPerUnit, profiles.compensation.annualSalary, profiles.compensation.currency

transform

birthdate

profiles.dob

one-to-one

contact.homeemail

profiles.personalEmail

one-to-one

contact.mobilephone

profiles.phone

one-to-one

contact.workemail

profiles.workEmail

one-to-one

department

profiles.department

one-to-one

employment

profiles.employmentType

one-to-one

enddate

profiles.endDate

one-to-one

gender

profiles.gender

one-to-one

imageurl

profiles.photo

one-to-one

location

profiles.workLocationName

one-to-one

manager

profiles.manager

one-to-one

name.first

profiles.firstName, profiles.workEmail

transform

name.last

profiles.lastName, profiles.workEmail

transform

name.pref

profiles.preferredFirstName

one-to-one

startdate

profiles.startDate

one-to-one

title

profiles.title

one-to-one

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 Rippling

Any ChartHop user with sufficient permissions can trigger an on-demand sync from Rippling 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. Find and select Rippling.
  4. 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 Rippling. Once completed, you will see a message indicating that the sync has been completed.

Permissions

To sync your Rippling 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 Rippling

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

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



Updated 27 Jul 2022
Did this page help you?
Yes
No