Important Note:
- Rippling used to offer OAuth method (which was previously supported by Allvoices). However, Rippling has made changes and encouraging customers to opt for Token/API route for integrations.
- Allvoices existing customers can continue to integrate with our Allvoices App in Rippling, however, please note Rippling may at their discretion move away from it and opt for Token method.
- Allvoices will support Token/API method for new/future customers. We also encourage our existing customers (using OAuth method) to switch over the Token route.
- This guide covers API/Token method.
- Our previous guide covers the deprecated OAuth method.
What’s needed
To authenticate with Rippling, you need:
- API Token - A key that grants secure access to the API, enabling authorized applications to interact with Rippling resources and services.
- You must have an account with Rippling with access to Token feature.
This guide will walk you through generating your API Token within Rippling.
Step 1: Generating Your API Token
- Log in to your Rippling account.
- Navigate to the API Tokens app by searching for it, finding it under ⚙️ Settings, or using the direct link.
- Create a new API Token by providing a name, unique identifier, and selecting the API version.
- Configure the API permissions based on the required access, which is determined by the current user’s permissions.
-
workers.read workers.sensitive.personal.read users.read employment-types.read departments.read - Copy and securely save the API Token, as it will only be displayed once
Step 2: Connect with UI in Allvoices
- Log in to your AllVoices Dashboard.
- Click the gear icon (⚙️) in the navigation bar.
- Go to “Integrations.”
- Click “Connect Integration” in the top-right corner.
- Choose Rippling from the platform list.
- Enter your Rippling Token/API Key.
That’s it—your Rippling account is now connected to AllVoices!
Baseline Fields that will be Synced
Field |
Value Type |
|---|---|
| id | string |
| firstName | string - Required |
| lastName | string |
| string - Required | |
| displayName | string |
| employeeNumber | string (optional) |
| title | string |
| department.id | string |
| department.name | string |
| employmentType | 'FULL_TIME' |
| employmentStatus | 'ACTIVE' |
| startDate | string (ISO date) |
| terminationDate | string (ISO date, optional) |
| manager.id | string (optional) |
| manager.firstName | string (optional) |
| manager.lastName | string (optional) |
| manager.email | string (optional) |
| workLocation.name | string |
| workLocation.type | 'OFFICE' |
| workLocation.primaryAddress.street | string (optional) |
| workLocation.primaryAddress.city | string (optional) |
| workLocation.primaryAddress.state | string (optional) |
| workLocation.primaryAddress.country | string (optional) |
| workLocation.primaryAddress.postalCode | string (optional) |
| workLocation.primaryAddress.type | 'WORK' |
| addresses[].street | string |
| addresses[].city | string |
| addresses[].state | string |
| addresses[].country | string |
| addresses[].postalCode | string |
| addresses[].type | 'HOME' |
| phones[].type | 'WORK' |
| phones[].number | string |
| emails[].type | 'WORK' |
| emails[].address | string |
| createdAt | string |
| updatedAt | string |
Rippling Specific Fields
Rippling Specific fields |
| date_of_birth |
| gender |
| race |
| ethnicity |
| citizenship |
| country_fields |
| is_manager |