Rippling Component
Rippling makes it easy to manage your company's Payroll, Benefits, HR, and IT—all in one, modern platform
Component key: rippling
Description
Rippling makes it easy to manage your company's Payroll, Benefits, HR, and IT—all in one, modern platform.
Connections
OAuth 2.0
To use OAuth 2.0 with Rippling you will need to coordinate with them in accordance with their Partner Requirements. Additionally, you may also refer to the Installation OAuth Guide.
Ensure to supply the callback URL: Enter https://oauth2.prismatic.io/callback.
You will need to collect a valid Client ID, Client Secret, and Authorize URL from this process.
Once you have this information you can create a connection:
- Enter the Client ID, Client Secret, and Authorize URL to the same named fields.
- Add space delimited scopes to that field. Refer to Rippling's scopes documentation for details.
Save your integration and you should now be able to connect to Rippling.
| Input | Notes | Example |
|---|---|---|
| Authorization URL | Authorization URL from Rippling | https://app.rippling/apps/PLATFORM/{AppName} |
| Client ID | Client identifier for your app supplied by Rippling | |
| Client Secret | Client secret for your app supplied by Rippling | |
| Scopes | Space-delimited scopes | |
| Token URL | Token URL | https://app.rippling.com/api/o/token/ |
Bearer API Key
| Input | Notes | Example |
|---|---|---|
| Authorization |
Actions
Delete Groups Group Id
DELETE Group | key: deleteGroupsGroupId
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Group Id | Unique identifier for the group within Rippling |
Get Companies
GET Current Company | key: getCompanies
| Input | Notes | Example |
|---|---|---|
| Connection |
Get Company Activity
GET Company Activity | key: getCompanyActivity
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| End Date | Timestamp to list activity before (inclusive) | |
| Limit | Specifies the number of results to page (maximum: 1000) (default: 1000) | |
| Next | Specifies the pagination cursor to the next page | |
| Start Date | Timestamp to list activity after (inclusive) |
Get Custom Fields
GET Custom Fields | key: getCustomFields
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Limit | Sets a limit on the returned values | |
| Offset | Offsets the returned values |
Get Departments
GET Departments | key: getDepartments
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Limit | Sets a limit on the returned values | |
| Offset | Offsets the returned values |
Get Employees
GET Employees | key: getEmployees
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Limit | Sets a limit on the returned values | |
| Offset | Offsets the returned values |
Get Employees Employee Id
GET Employee | key: getEmployeesEmployeeId
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Employee Id | Unique identifier for the employee within Rippling |
Get Employees Include Terminated
GET Employees (Including Terminated) | key: getEmployeesIncludeTerminated
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| EIN | Employer identification number, also known as the Federal Emplower Identification Number or the Federal Tax Identification Number | |
| Limit | Sets a limit on the returned values | |
| Offset | Offsets the returned values |
Get Groups
GET Groups | key: getGroups
| Input | Notes | Example |
|---|---|---|
| Connection |
Get Leave Requests
GET Leave Requests | key: getLeaveRequests
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| End Date | End date of leave | |
| From | Filter to capture whether the leave request overlaps with a date range | |
| Id | ||
| Leave Policy | ||
| Processed By | ||
| Requested By | ||
| Role | ||
| Start Date | Start date of leave | |
| Status | ||
| To | Filter to capture whether the leave request overlaps with a date range |
Get Levels
GET Levels | key: getLevels
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Limit | Sets a limit on the returned values | |
| Offset | Offsets the returned values |
Get Me
GET Current User | key: getMe
| Input | Notes | Example |
|---|---|---|
| Connection |
Get Saml Idp Metadata
GET SAML Metadata | key: getSamlIdpMetadata
| Input | Notes | Example |
|---|---|---|
| Connection |
Get Teams
GET Teams | key: getTeams
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Limit | Sets a limit on the returned values | |
| Offset | Offsets the returned values |
Get Work Locations
GET Work Locations | key: getWorkLocations
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Limit | Sets a limit on the returned values | |
| Offset | Offsets the returned values |
Patch Groups Group Id
PATCH Group | key: patchGroupsGroupId
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Group Id | Unique identifier for the group within Rippling | |
| Name | The name of the Group | |
| Spoke Id | The external identifier of the Group | |
| Users | The array of users within the Group | |
| Version | The version identifier of the Group |
Post Ats Candidates Push Candidate
POST New Candidate | key: postAtsCandidatesPushCandidate
| Input | Notes | Example |
|---|---|---|
| Attachments | ||
| Candidate Id | The unique identifier of the candidate from the ATS | |
| Connection | ||
| Currency | A string field of the ofifcial currency doe as listed in ISO 4217 | |
| Department | The department name as a string | |
The candidate's email | ||
| Employment Type | The ENUM type of employment the user will have within Rippling | |
| Equity Shares | The number of shares that will be given to the candidate | |
| Job Title | The candidate's job title | |
| Name | The candidate's name | |
| Phone Number | The candidate's phone number | |
| Salary Per Unit | The decimal value that the candidate gets paid every salaryUnit time period | |
| Salary Unit | An ENUM string value, denoting the frequency at which the candidate should be paid once the role begins | |
| Signing Bonus | The bonus cash given to the candidate as a part of a one time payment, with two decimal digit precision | |
| Start Date | The would-be start date of the candidate |
Post Groups
POST Groups | key: postGroups
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Name | User-readable name of the group | |
| Spoke Id | The unique ID for the group, this can be the unique identifier for the group entity object within your application | |
| Users | An array of Rippling IDs that will be in the group |
Post Mark App Installed
Mark App Installed | key: postMarkAppInstalled
| Input | Notes | Example |
|---|---|---|
| Connection |
Process Leave Requests
POST Process Leave Request | key: processLeaveRequests
| Input | Notes | Example |
|---|---|---|
| Action | The action to be taken on the leave request | |
| Connection | ||
| Id | Unique identifier of the leave request being processed |
Put Groups Group Id
PUT Group | key: putGroupsGroupId
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Group Id | Unique identifier for the group within Rippling | |
| Name | The name of the Group | |
| Spoke Id | The external identifier of the Group | |
| Users | The array of users within the Group | |
| Version | The version identifier of the Group |
Raw Request
Send raw HTTP request to Rippling | key: rawRequest
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Data | The HTTP body payload to send to the URL. Must be a string or a reference to output from a previous step. | {"exampleKey": "Example Data"} |
| Debug Request | Enabling this flag will log out the current request. | false |
| File Data | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] |
| Form Data | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] |
| Header | A list of headers to send with the request. | User-Agent: curl/7.64.1 |
| Max Retry Count | The maximum number of retries to attempt. | 0 |
| Method | The HTTP method to use. | |
| Query Parameter | A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2. | |
| Response Type | The type of data you expect in the response. You can request json, text, or binary data. | json |
| Retry On All Errors | If true, retries on all erroneous responses regardless of type. | false |
| Retry Delay (ms) | The delay in milliseconds between retries. | 0 |
| Timeout | The maximum time that a client will await a response to its request | 2000 |
| URL | Input the path only (/companies/current), The base URL is already included (https://api.rippling.com/platform/api). For example, to connect to https://api.rippling.com/platform/api/companies/current, only /companies/current is entered in this field. | /companies/current |
| Use Exponential Backoff | Specifies whether to use a pre-defined exponential backoff strategy for retries. | false |