You will create a Rippling API token, give it the read access needed for your connection, and enter the token in the secure Clarity connection window.
BEFORE YOU BEGIN
You will need Rippling admin access and permission to create API Tokens. The token will inherit the permissions of the person who creates it.
Open API Tokens
Navigate to Rippling’s API Tokens area to begin the connection setup.
- Sign in to Rippling.
- Go to Tools → Developer → API Tokens, or search for “API Tokens” in Rippling.
- Select Create API Token.
TIP
If you cannot see API Tokens, confirm that your Rippling account has sufficient admin permissions.
Create Your API Token
Name the token and select the read access needed for the Clarity connection.
- Enter a clear name, such as “Clarity Integration,” and select Continue.
- On the Scopes screen, enable the required read scopes shown below.
| Data | Required read scopes |
|---|---|
| Employee | workers.read, levels.read, users.read, legal-entities.read, employment-types.read, compensations.read, teams.read, custom-fields.read, departments.read, work-locations.read, workers.custom-fields.read |
| Company | companies.read |
| Compensation | compensations.read |
| Employment | employment-types.read |
| Time Off | leave-balances.read, leave-requests.read, leave-types.read |
| Timesheets | time-entries.read |
WHY THESE PERMISSIONS MATTER
The token can only access data that both the selected scopes and the creating administrator allow. If a required scope is missing, that data may not sync.
Generate and Save Your Token
Create the token and copy it before leaving the screen.
- Select Save to generate the API token.
- Copy the API Token and store it securely.
IMPORTANT
Rippling displays the token only once. If you close the window before copying it, you will need to create a new token.
TOKEN EXPIRATION
Rippling API Tokens expire after 30 days of inactivity. As long as the token remains in active use, it stays valid.
Once you have copied the token, you are ready to complete the secure Clarity connection.
Connect Rippling to Clarity
Enter the API token in the secure Clarity connection window.
- Open the secure Clarity connection link provided to you.
- Select Allow and Continue.
- Paste your Rippling API Token into the prompt.
- Select Connect.
You’re Connected!
Once the token is accepted, your secure Rippling connection to Clarity is complete and data will begin syncing.
Having trouble?
| Invalid token | Confirm the token was copied in full with no extra spaces. Create a new token if needed. |
| Missing employee or worker data | Confirm all required read scopes were selected. |
| Cannot find API Tokens | Confirm you have sufficient Rippling admin access. |