/
Rippling to JSM Assets

Rippling to JSM Assets

Rippling to JSM Assets Integration Guide

This page explains how to use OnLink to import employee data from Rippling into Jira Service Management Assets.

Overview

OnLink imports Rippling API responses into Jira Service Management Assets object types using mapping statements such as key:, map:, and config:. Use this pattern for Rippling resources such as workers, departments, job functions, companies, and teams.

The high-level process is:

  1. Create or confirm the target Assets schema and object type.

  2. Create a Rippling API token.

  3. Configure an OnLink Assets Data Source that authenticates to Rippling with a bearer token.

  4. Set the API method and Rippling endpoint, then fetch sample data.

  5. Map JSON fields from the Rippling response to Assets attributes.

  6. Run Get Data to validate the result, then run the import when the mapping is correct.

Prerequisites

  • A Jira Service Management Assets schema and object type for the data you want to import.

  • OnLink installed and available from Manage your apps.

  • A Rippling API token with access to the required API endpoints.

  • Permission in JSM Assets to configure data sources, mappings, and imports.

  • The Rippling API endpoint URL for the object type you plan to import.

Supported Rippling object types

The examples on this page use Rippling worker data. The same pattern can be adapted for other Rippling resources, such as users, departments, job functions, companies, and teams, by selecting the appropriate API endpoint and mapping the returned JSON fields to the matching Assets attributes.

1. Create the Rippling API token

To generate a token, follow the steps in Rippling’s API Tokens documentation:

  1. In Rippling, navigate to the API Tokens app (search for it, or find it under Settings).

  2. Click to create a new API token, provide a name and unique identifier, and select the API version.

  3. Configure the scopes for the token e.g to get workers, the scope needs to be workers.read

  4. Copy and securely store the token.

Use the token generated above in the OnLink connection.

2. Configure the OnLink data source

  1. In OnLink, add an Assets Data Source.

  2. Set Authentication Type to Bearer Token.

  3. Set the header name to Authorization.

  4. Paste the token generated in Rippling.

image-20260711-204608.png

 

3. Configure the API method

Use a GET request to retrieve records from the Rippling API. For example, to fetch workers, configure the request as follows:

  1. Set Method to GET.

  2. Set URL to https://rest.ripplingapis.com/workers/.

  3. Set Response data path to results.

  4. Leave the remaining configuration at the default values unless your Rippling API endpoint requires additional parameters.

GET https://rest.ripplingapis.com/workers/
image-20260711-203907.png

4. Fetch sample data

Save the connection, then run it to fetch sample values from Rippling. Use the returned sample JSON to confirm that the endpoint is correct and to identify the field names needed for mapping.

When inspecting the sample response, look for the field path that contains the value you want to import. For example, a worker email may appear as work_email, while nested values may require mapping from the nested JSON structure returned by Rippling.

5. Configure pagination

Rippling API responses may be paginated. If the sample response includes pagination fields such as a result count or next-page URL, confirm that the OnLink data source configuration is set up to retrieve the full dataset expected for your import.

The endpoint returns a paginated list using cursor-based pagination:

  • Use the page size parameter to control page size.

  • Set the Max pages to 10. This is important as Rippling API recommends smaller pages.

  • Each response includes a next_link / cursor for the next page; keep following it until it returns null.

image-20260711-204151.png

6. Apply filtering

You can refine results using the filter query parameter. Filterable fields include status, work_email, user_id, created_at, and updated_at. For example, to import only active workers:

GET https://rest.ripplingapis.com/workers?filter=status eq "ACTIVE"
image-20260711-204241.png

7. Configure the Assets import and mapping

After the connection is established, create the Assets import by following the JSM Assets Data Synchronization guide.

Use the fetched API sample to identify the Rippling JSON field names and map them to the corresponding JSM Assets attributes. The key: mapping should identify the stable unique value used to match and update existing Assets objects.

Mapping or setting

Purpose and usage

Mapping or setting

Purpose and usage

key:id=WorkerID

The key prefix defines the unique identifier. Rippling’s worker id maps to the WorkerID attribute in Assets, so future syncs update existing objects instead of creating duplicates.

map:work_email=Work Email

The map prefix connects a source field to an Assets attribute. Syntax: map:[Rippling_Field]=[Assets_Attribute].

map:title=Title

Maps the worker’s job title to the corresponding Assets attribute.

map:employment_type=Employment Type

Captures whether the worker is a full-time employee, part-time employee, or contractor for reporting, access policies, and automations.

map:manager_id=Manager|WorkerID=${manager_id}

Creates a reference mapping to another Worker object. The Manager Assets attribute points to the Worker object whose WorkerID matches ${manager_id}.

map:department_id=Department|RefID=${department_id}

Links the worker to a Department object whose RefID matches the Rippling department_id. If the referenced object does not exist, OnLink can create it with config:enable_object_creation=true, or you can suppress creation with |create=false.

map:teams_id=Teams|RefID=${teams_id}

Maps array values from teams_id to referenced Team objects. Configure the Assets attribute cardinality to allow multiple values when a worker can belong to multiple teams.

Mapping guidance

  • Start with one unique key: mapping so OnLink can identify whether to create or update an Assets object.

  • Add map: entries for each Rippling field you want to store in Assets.

  • Compare the Rippling sample JSON with the Assets object type attributes before running an import.

  • If a value is nested in the JSON response, inspect the sample output carefully and use the field path supported by the OnLink mapping configuration.

8. Validate and run the import

  1. Use Get Data first to preview the data returned by Rippling.

  2. Confirm that the sample records contain the expected fields and values.

  3. Verify that the key field maps to a unique Assets attribute.

  4. Review the object type mapping and attribute names for spelling and case consistency.

  5. Run the import only after the previewed data and mapping are correct.