> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/rippling.md).

# Rippling

Read workers, org structure, leave, and time tracking data from Rippling, the HR, IT, and finance platform, and write back leave requests, draft hires, job assignments, and group membership. Creating or deleting a group: the operation requires a separate Rippling Base API connection.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector                   | Authentication |
| --------------------------- | -------------- |
| Rippling                    | API Key        |
| Rippling (OAuth)            | OAuth sign-in  |
| Rippling (Group Management) | OAuth sign-in  |

### Rippling

Authenticate to Rippling with a self-issued API key from the Rippling developer portal. Supports every standard Rippling action and trigger, including writes such as booking time off, updating job assignments, and moving people in and out of groups. Creating and deleting groups needs the Rippling (Group Management) connector instead.

#### Set up in Rippling

1. Prepare the Rippling account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** Create an API token in Rippling under Tools > Developer > API Tokens, then select Create API token. This requires the "Create and manage API Tokens" permission. Rippling shows the token only once, at creation time, so copy it immediately. Rippling automatically revokes a token if it goes unused for 30 days, or if the token's owner is terminated.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Rippling**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                                                                                                                                                                                                                               |
| ------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| API Key       | Yes      | Create an API token in Rippling under Tools > Developer > API Tokens, then select Create API token. This requires the "Create and manage API Tokens" permission. Rippling shows the token only once, at creation time, so copy it immediately. Rippling automatically revokes a token if it goes unused for 30 days, or if the token's owner is terminated. |

### Rippling (OAuth)

Authenticate to Rippling through its hosted OAuth2 sign-in instead of pasting an API key. Supports the same standard Rippling actions and triggers as the API key connector, including writes such as booking time off, updating job assignments, and moving people in and out of groups. Creating and deleting groups needs the Rippling (Group Management) connector instead.

#### Set up in Rippling

1. Use a Rippling account with access to the records and operations that your workflow needs.
2. Register or select the OAuth application described in the fields below. Add the redirect URI displayed in StackAI to that application and retain its client ID and secret, where required.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Rippling (OAuth)**.
2. Complete the connector configuration below. If you do not have access to these settings, ask your StackAI administrator to configure the connector.
3. Select **Connect**, sign in to the provider account, and review the requested access. Complete authorization to return to StackAI.
4. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connector configuration**

| StackAI field | Required  | What to enter                                                                                                                                                                         |
| ------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| OAuth Scopes  | Read-only | Fixed scope set covering every action and trigger this integration supports. This value is shown for reference; it is not an editable credential.                                     |
| Client ID     | Yes       | OAuth 2.0 Client ID from a Rippling App Shop partner app registration. [Provider instructions](https://developer.rippling.com/documentation/developer-portal/v2-guides/registration). |
| Client Secret | Yes       | OAuth 2.0 Client Secret from the matching Rippling app registration.                                                                                                                  |
| Redirect URI  | Read-only | Use this redirect URI when configuring your OAuth application. This value is shown for reference; it is not an editable credential.                                                   |

### Rippling (Group Management)

Connect to Rippling's legacy Base API to create and delete groups. Requires a Rippling partner app listing; every other Rippling action uses the standard Rippling connector instead.

#### Set up in Rippling

1. Use a Rippling account with access to the records and operations that your workflow needs.
2. Register or select the OAuth application described in the fields below. Add the redirect URI displayed in StackAI to that application and retain its client ID and secret, where required.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Rippling (Group Management)**.
2. Complete the connector configuration below. If you do not have access to these settings, ask your StackAI administrator to configure the connector.
3. Select **Connect**, sign in to the provider account, and review the requested access. Complete authorization to return to StackAI.
4. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connector configuration**

| StackAI field    | Required  | What to enter                                                                                                                                                                                                                                                                                            |
| ---------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| OAuth Scopes     | Read-only | OAuth scopes for the connector. This value is shown for reference; it is not an editable credential.                                                                                                                                                                                                     |
| Client ID        | Yes       | OAuth 2.0 Client ID from the Rippling partner app listing.                                                                                                                                                                                                                                               |
| Client Secret    | Yes       | OAuth 2.0 Client Secret from the matching Rippling partner app listing.                                                                                                                                                                                                                                  |
| Redirect URI     | Read-only | Use this redirect URI when configuring your OAuth application. This value is shown for reference; it is not an editable credential.                                                                                                                                                                      |
| App Listing Name | Yes       | Your Rippling partner app listing's name, taken from its Authorization URL: app.rippling.com/apps/PLATFORM/\<this-value>/authorize. Find it in Rippling under Partner > Client Command Center, on the app listing's details page. This field is only usable once Rippling has approved that app listing. |

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **Rippling** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### List Workers

List the people in your Rippling company, optionally narrowed to active or terminated employees.

**Required permissions:** `workers.read`.

#### Inputs

| Field                   | Type                      | Required | Description                                                                                                                                                                                               |
| ----------------------- | ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Employment Status       | select (string)           | No       | Only return workers with this employment status. Leave empty to return everyone. Available values: Hired, Accepted, Active, Terminated.                                                                   |
| Work Email              | string                    | No       | Find one specific person by their exact work email address.                                                                                                                                               |
| Show advanced options   | boolean                   | No       | Show related-record expansion and pagination controls. Default: false.                                                                                                                                    |
| Include Related Records | multiple\_select (string) | No       | Pull related records inline so you do not need a second lookup. Available values: User, Manager, Legal Entity, Employment Type, Department, Teams, Level, Job Function, Custom Fields, Business Partners. |
| Page Cursor             | string                    | No       | Continue from a previous page. Leave empty to start at the first page.                                                                                                                                    |

#### Outputs

| Field            | Type          | Description                                                     |
| ---------------- | ------------- | --------------------------------------------------------------- |
| Workers          | object\_array | The page of worker records returned by Rippling.                |
| Next Page Cursor | string        | Cursor for the next page. Empty when there are no more results. |

### Get Worker

Get the full profile for one person in Rippling.

**Required permissions:** `workers.read`.

#### Inputs

| Field                   | Type                      | Required | Description                                                                                                                                                                                       |
| ----------------------- | ------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Worker                  | select (string)           | Yes      | The Rippling worker whose profile you want. Options load from the selected connection.                                                                                                            |
| Show advanced options   | boolean                   | No       | Show related-record expansion controls. Default: false.                                                                                                                                           |
| Include Related Records | multiple\_select (string) | No       | Pull related records inline, as a comma-separated list. Available values: User, Manager, Legal Entity, Employment Type, Department, Teams, Level, Job Function, Custom Fields, Business Partners. |

#### Outputs

| Field  | Type   | Description         |
| ------ | ------ | ------------------- |
| Worker | object | The worker profile. |

### List Org Structure

List your company's departments, teams, work locations, legal entities, career tracks or levels.

**Required permissions:** `departments.read`, `teams.read`, `levels.read`, `tracks.read`, `work-locations.read`, `legal-entities.read`.

#### Inputs

| Field        | Type            | Required | Description                                                                                                                                                 |
| ------------ | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| What to list | select (string) | Yes      | Departments, teams, levels, tracks, work locations or legal entities. Available values: Departments, Teams, Levels, Tracks, Work Locations, Legal Entities. |
| Page Cursor  | string          | No       | Continue from a previous page. Leave empty to start at the first page.                                                                                      |

#### Outputs

| Field            | Type          | Description                                                     |
| ---------------- | ------------- | --------------------------------------------------------------- |
| Records          | object\_array | The page of org structure records.                              |
| Next Page Cursor | string        | Cursor for the next page. Empty when there are no more results. |

### List Leave Types

List the time-off and leave types your company offers, such as vacation or sick leave.

**Required permissions:** `leave-types.read`.

#### Inputs

| Field       | Type   | Required | Description                                                            |
| ----------- | ------ | -------- | ---------------------------------------------------------------------- |
| Name        | string | No       | Find one leave type by its exact name.                                 |
| Page Cursor | string | No       | Continue from a previous page. Leave empty to start at the first page. |

#### Outputs

| Field            | Type          | Description                                                     |
| ---------------- | ------------- | --------------------------------------------------------------- |
| Leave Types      | object\_array | The page of leave types.                                        |
| Next Page Cursor | string        | Cursor for the next page. Empty when there are no more results. |

### Get Leave Balances

Check how much time off someone has left, by leave type.

**Required permissions:** `leave-balances.read`.

#### Inputs

| Field       | Type            | Required | Description                                                                                                            |
| ----------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------- |
| Worker      | select (string) | No       | Whose balances to check. Leave empty to return balances across the company. Options load from the selected connection. |
| Leave Type  | select (string) | No       | Narrow to a single leave type, such as vacation. Options load from the selected connection.                            |
| Page Cursor | string          | No       | Continue from a previous page. Leave empty to start at the first page.                                                 |

#### Outputs

| Field            | Type          | Description                                                     |
| ---------------- | ------------- | --------------------------------------------------------------- |
| Leave Balances   | object\_array | The page of leave balance records.                              |
| Next Page Cursor | string        | Cursor for the next page. Empty when there are no more results. |

### List Leave Requests

List time-off requests, optionally narrowed to one person or one approval status.

**Required permissions:** `leave-requests.read`.

#### Inputs

| Field                 | Type            | Required | Description                                                                                                                                       |
| --------------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| Worker                | select (string) | No       | Only show requests made by this person. Options load from the selected connection.                                                                |
| Approval Status       | select (string) | No       | Only show requests in this approval state, such as pending requests awaiting a decision. Available values: Pending, Approved, Rejected, Canceled. |
| Leave Type            | select (string) | No       | Narrow to one leave type, such as vacation. Options load from the selected connection.                                                            |
| Show advanced options | boolean         | No       | Show reviewer and pagination controls. Default: false.                                                                                            |
| Reviewer              | select (string) | No       | Only show requests assigned to this approver. Options load from the selected connection.                                                          |
| Page Cursor           | string          | No       | Continue from a previous page. Leave empty to start at the first page.                                                                            |

#### Outputs

| Field            | Type          | Description                                                     |
| ---------------- | ------------- | --------------------------------------------------------------- |
| Leave Requests   | object\_array | The page of leave requests.                                     |
| Next Page Cursor | string        | Cursor for the next page. Empty when there are no more results. |

### List Time Entries

Pull clock-in and clock-out records for time and attendance reporting.

**Required permissions:** `time-entries.read`.

#### Inputs

| Field       | Type            | Required | Description                                                                                               |
| ----------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------- |
| Worker      | select (string) | No       | Whose time entries to pull. Leave empty for the whole company. Options load from the selected connection. |
| From Date   | date            | No       | Only include entries starting on or after this date.                                                      |
| To Date     | date            | No       | Only include entries starting on or before this date.                                                     |
| Page Cursor | string          | No       | Continue from a previous page. Leave empty to start at the first page.                                    |

#### Outputs

| Field            | Type          | Description                                                     |
| ---------------- | ------------- | --------------------------------------------------------------- |
| Time Entries     | object\_array | The page of time entries.                                       |
| Next Page Cursor | string        | Cursor for the next page. Empty when there are no more results. |

### Get Company Info

Get your Rippling company details and confirm which account the connection is using.

**Required permissions:** `companies.read`, `sso-me.read`.

#### Inputs

No input fields are required in this catalog entry.

#### Outputs

| Field                   | Type   | Description                                     |
| ----------------------- | ------ | ----------------------------------------------- |
| Company                 | object | The connected Rippling company.                 |
| Connected Account Email | string | The work email the connection authenticates as. |

### Create Leave Request

Book time off for someone in Rippling.

**Required permissions:** `leave-requests.read-write`.

#### Inputs

| Field                 | Type            | Required | Description                                                                                                                                   |
| --------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| Worker                | select (string) | Yes      | Who the time off is for. Options load from the selected connection.                                                                           |
| Leave Type            | select (string) | Yes      | Which leave type to book against, such as vacation. Options load from the selected connection.                                                |
| Status                | select (string) | No       | What state to create the request in. Defaults to pending approval. Available values: Pending, Approved, Rejected, Canceled. Default: PENDING. |
| Start Date            | date            | Yes      | First day of leave.                                                                                                                           |
| End Date              | date            | Yes      | Last day of leave.                                                                                                                            |
| Show advanced options | boolean         | No       | Show the optional note field. Default: false.                                                                                                 |
| Note                  | textarea        | No       | Optional note shown on the request.                                                                                                           |

#### Outputs

| Field         | Type   | Description          |
| ------------- | ------ | -------------------- |
| Leave Request | object | The created request. |

### Update Leave Request

Approve, decline or change an existing time-off request.

**Required permissions:** `leave-requests.read-write`.

#### Inputs

| Field                 | Type            | Required | Description                                                                                       |
| --------------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------- |
| Leave Request         | select (string) | Yes      | Which request to update. Options load from the selected connection.                               |
| Status                | select (string) | No       | Approve, decline, or cancel the request. Available values: Pending, Approved, Rejected, Canceled. |
| Show advanced options | boolean         | No       | Show controls for changing the leave dates or adding a note. Default: false.                      |
| Start Date            | date            | No       | Change the first day of leave.                                                                    |
| End Date              | date            | No       | Change the last day of leave.                                                                     |
| Note                  | textarea        | No       | Note explaining the decision.                                                                     |

#### Outputs

| Field         | Type   | Description          |
| ------------- | ------ | -------------------- |
| Leave Request | object | The updated request. |

### Add Worker To Group

Add someone to a Rippling group. This can grant them access to connected apps.

**Required permissions:** `supergroups.read-write`.

#### Inputs

| Field  | Type            | Required | Description                                                                  |
| ------ | --------------- | -------- | ---------------------------------------------------------------------------- |
| Group  | select (string) | Yes      | Which group to add the person to. Options load from the selected connection. |
| Worker | select (string) | Yes      | Who to add. Options load from the selected connection.                       |

#### Outputs

| Field     | Type    | Description                           |
| --------- | ------- | ------------------------------------- |
| Succeeded | boolean | Whether Rippling accepted the change. |

### Remove Worker From Group

Remove someone from a Rippling group. This can revoke their access to connected apps.

**Required permissions:** `supergroups.read-write`.

#### Inputs

| Field  | Type            | Required | Description                                                                       |
| ------ | --------------- | -------- | --------------------------------------------------------------------------------- |
| Group  | select (string) | Yes      | Which group to remove the person from. Options load from the selected connection. |
| Worker | select (string) | Yes      | Who to remove. Options load from the selected connection.                         |

#### Outputs

| Field     | Type    | Description                           |
| --------- | ------- | ------------------------------------- |
| Succeeded | boolean | Whether Rippling accepted the change. |

### List Groups

List your company's Rippling groups.

**Required permissions:** `supergroups.read`.

#### Inputs

| Field       | Type   | Required | Description                                                            |
| ----------- | ------ | -------- | ---------------------------------------------------------------------- |
| Page Cursor | string | No       | Continue from a previous page. Leave empty to start at the first page. |

#### Outputs

| Field            | Type          | Description                                                     |
| ---------------- | ------------- | --------------------------------------------------------------- |
| Groups           | object\_array | The page of groups.                                             |
| Next Page Cursor | string        | Cursor for the next page. Empty when there are no more results. |

### List App Users

See which people are assigned to which connected applications.

**Required permissions:** `app-users.read`.

#### Inputs

| Field       | Type            | Required | Description                                                                                  |
| ----------- | --------------- | -------- | -------------------------------------------------------------------------------------------- |
| Worker      | select (string) | No       | Only show application assignments for one person. Options load from the selected connection. |
| Application | string          | No       | Only show assignments for one connected application.                                         |
| Page Cursor | string          | No       | Continue from a previous page. Leave empty to start at the first page.                       |

#### Outputs

| Field            | Type          | Description                                                     |
| ---------------- | ------------- | --------------------------------------------------------------- |
| App Users        | object\_array | The page of app-user assignments.                               |
| Next Page Cursor | string        | Cursor for the next page. Empty when there are no more results. |

### Update Job Assignment

Move someone to a different job code in Rippling.

**Required permissions:** `job-assignments.read-write`.

#### Inputs

| Field          | Type            | Required | Description                                                                                                         |
| -------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------- |
| Worker         | select (string) | Yes      | Which worker this job assignment belongs to. Options load from the selected connection.                             |
| Job Assignment | select (string) | Yes      | Which of this worker's job assignments to change. Pick the worker first. Options load from the selected connection. |
| Job Code       | select (string) | Yes      | The job code to move the person to. Options load from the selected connection.                                      |

#### Outputs

| Field          | Type   | Description                 |
| -------------- | ------ | --------------------------- |
| Job Assignment | object | The updated job assignment. |

### Create Draft Hire

Start a new hire in Rippling as a draft for an admin to complete.

**Required permissions:** `draft-hires.read-write`, `employment-types.read`.

#### Inputs

| Field                 | Type            | Required | Description                                                                                          |
| --------------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------- |
| First Name            | string          | Yes      | The new hire's first name.                                                                           |
| Last Name             | string          | Yes      | The new hire's last name.                                                                            |
| Work Email            | string          | Yes      | Their work email address. Must be unique in the company.                                             |
| Job Title             | string          | Yes      | The new hire's job title.                                                                            |
| Employment Type       | select (string) | Yes      | Whether the person is an employee, contractor, and so on. Options load from the selected connection. |
| Start Date            | date            | Yes      | Their first day.                                                                                     |
| Show advanced options | boolean         | No       | Show department and work location assignment. Default: false.                                        |
| Department            | select (string) | No       | Which department they join. Options load from the selected connection.                               |
| Work Location         | select (string) | No       | Where they will be based. Options load from the selected connection.                                 |
| Invite Email          | string          | No       | Where Rippling sends the onboarding invite. Defaults to the work email.                              |

#### Outputs

| Field      | Type   | Description             |
| ---------- | ------ | ----------------------- |
| Draft Hire | object | The created draft hire. |

### Create Group

Create a new group in Rippling. Groups control which apps their members can access.

#### Inputs

| Field                 | Type    | Required | Description                                                                                         |
| --------------------- | ------- | -------- | --------------------------------------------------------------------------------------------------- |
| Name                  | string  | Yes      | What to call the group.                                                                             |
| Show advanced options | boolean | No       | Show the rarely-needed spoke id field. Default: false.                                              |
| Spoke ID (advanced)   | string  | No       | Rarely needed. Only set this if Rippling support or your admin gave you a specific spoke id to use. |

#### Outputs

| Field | Type   | Description        |
| ----- | ------ | ------------------ |
| Group | object | The created group. |

### Delete Group

Permanently delete a Rippling group. Members lose any app access the group granted.

#### Inputs

| Field | Type            | Required | Description                                                       |
| ----- | --------------- | -------- | ----------------------------------------------------------------- |
| Group | select (string) | Yes      | Which group to delete. Options load from the selected connection. |

#### Outputs

| Field   | Type    | Description                    |
| ------- | ------- | ------------------------------ |
| Deleted | boolean | Whether the group was deleted. |

## Triggers

A trigger starts a workflow when its configured event occurs. Configure the event and filters before enabling the trigger.

### On Worker Added or Updated

Starts the workflow when someone is hired, terminated, or has their profile changed in Rippling.

Optionally limit this to one employment status, for example 'TERMINATED' to watch only departures. Leave it blank to fire on any worker change. The connected API token needs the workers.read scope, granted in Rippling under Tools > Developer > API Tokens.

**Required permissions:** `workers.read`.

#### Configuration

| Field                   | Type                      | Required | Description                                                                                                                                                                                                            |
| ----------------------- | ------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Only For Status         | select (string)           | No       | Only fire for workers in this status, for example only for terminations. Available values: Hired, Accepted, Active, Terminated.                                                                                        |
| Include Related Records | multiple\_select (string) | No       | Pull related records inline on each fired worker, as a comma-separated list. Available values: User, Manager, Legal Entity, Employment Type, Department, Teams, Level, Job Function, Custom Fields, Business Partners. |

#### Event inputs

| Field  | Type   | Required | Description                           |
| ------ | ------ | -------- | ------------------------------------- |
| Worker | object | Yes      | The worker that was added or changed. |

#### Outputs

| Field  | Type   | Description                           |
| ------ | ------ | ------------------------------------- |
| Worker | object | The worker that was added or changed. |

## Important behavior

If an operation is denied, check the connection’s granted permissions and the account’s access in the provider. Reauthorize the connection when it needs additional permissions.

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/rippling.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
