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 Prismatic's callback URL: Enter https://oauth2.prismatic.io/callback for US based integrations.
- For integrations outside the US refer to this guide to find your region’s Callback URL
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 within Prismatic:
- 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 | Default | Notes | Example |
|---|---|---|---|
Authorization URL string / Required authorizeUrl | Authorization URL from Rippling | https://app.rippling/apps/PLATFORM/{AppName} | |
Client ID string / Required clientId | Client identifier for your app supplied by Rippling | ||
Client Secret password / Required clientSecret | Client secret for your app supplied by Rippling | ||
Scopes string / Required scopes | Space-delimited scopes | ||
Token URL string / Required Hidden Field tokenUrl | https://app.rippling.com/api/o/token/ | Token URL |
Bearer API Key
| Input | Notes |
|---|---|
Authorization password / Required apiKey |
Actions
Delete Groups Group Id
DELETE Group | key: deleteGroupsGroupId
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Group Id string / Required groupId | Unique identifier for the group within Rippling |
Get Companies
GET Current Company | key: getCompanies
| Input | Notes |
|---|---|
Connection connection / Required connection |
Get Company Activity
GET Company Activity | key: getCompanyActivity
| Input | Notes |
|---|---|
Connection connection / Required connection | |
End Date string endDate | Timestamp to list activity before (inclusive) |
Limit string limit | Specifies the number of results to page (maximum: 1000) (default: 1000) |
Next string next | Specifies the pagination cursor to the next page |
Start Date string startDate | Timestamp to list activity after (inclusive) |
Get Custom Fields
GET Custom Fields | key: getCustomFields
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Limit string limit | Sets a limit on the returned values |
Offset string offset | Offsets the returned values |
Get Departments
GET Departments | key: getDepartments
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Limit string limit | Sets a limit on the returned values |
Offset string offset | Offsets the returned values |
Get Employees
GET Employees | key: getEmployees
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Limit string limit | Sets a limit on the returned values |
Offset string offset | Offsets the returned values |
Get Employees Employee Id
GET Employee | key: getEmployeesEmployeeId
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Employee Id string / Required employeeId | Unique identifier for the employee within Rippling |
Get Employees Include Terminated
GET Employees (Including Terminated) | key: getEmployeesIncludeTerminated
| Input | Notes |
|---|---|
Connection connection / Required connection | |
EIN string ein | Employer identification number, also known as the Federal Emplower Identification Number or the Federal Tax Identification Number |
Limit string limit | Sets a limit on the returned values |
Offset string offset | Offsets the returned values |
Get Groups
GET Groups | key: getGroups
| Input | Notes |
|---|---|
Connection connection / Required connection |
Get Leave Requests
GET Leave Requests | key: getLeaveRequests
| Input | Notes |
|---|---|
Connection connection / Required connection | |
End Date string endDate | End date of leave |
From string from | Filter to capture whether the leave request overlaps with a date range |
Id string id | |
Leave Policy string leavePolicy | |
Processed By string processedBy | |
Requested By string requestedBy | |
Role string role | |
Start Date string startDate | Start date of leave |
Status string status | |
To string to | Filter to capture whether the leave request overlaps with a date range |
Get Levels
GET Levels | key: getLevels
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Limit string limit | Sets a limit on the returned values |
Offset string offset | Offsets the returned values |
Get Me
GET Current User | key: getMe
| Input | Notes |
|---|---|
Connection connection / Required connection |
Get Saml Idp Metadata
GET SAML Metadata | key: getSamlIdpMetadata
| Input | Notes |
|---|---|
Connection connection / Required connection |
Get Teams
GET Teams | key: getTeams
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Limit string limit | Sets a limit on the returned values |
Offset string offset | Offsets the returned values |
Get Work Locations
GET Work Locations | key: getWorkLocations
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Limit string limit | Sets a limit on the returned values |
Offset string offset | Offsets the returned values |
Patch Groups Group Id
PATCH Group | key: patchGroupsGroupId
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Group Id string / Required groupId | Unique identifier for the group within Rippling |
Name string name | The name of the Group |
Spoke Id string spokeId | The external identifier of the Group |
Users string users | The array of users within the Group |
Version string version | The version identifier of the Group |
Post Ats Candidates Push Candidate
POST New Candidate | key: postAtsCandidatesPushCandidate
| Input | Notes |
|---|---|
Attachments string attachments | |
Candidate Id string candidateId | The unique identifier of the candidate from the ATS |
Connection connection / Required connection | |
Currency string currency | A string field of the ofifcial currency doe as listed in ISO 4217 |
Department string department | The department name as a string |
Email string email | The candidate's email |
Employment Type string employmentType | The ENUM type of employment the user will have within Rippling |
Equity Shares string equityShares | The number of shares that will be given to the candidate |
Job Title string jobTitle | The candidate's job title |
Name string name | The candidate's name |
Phone Number string phoneNumber | The candidate's phone number |
Salary Per Unit string salaryPerUnit | The decimal value that the candidate gets paid every salaryUnit time period |
Salary Unit string salaryUnit | An ENUM string value, denoting the frequency at which the candidate should be paid once the role begins |
Signing Bonus string signingBonus | The bonus cash given to the candidate as a part of a one time payment, with two decimal digit precision |
Start Date string startDate | The would-be start date of the candidate |
Post Groups
POST Groups | key: postGroups
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Name string name | User-readable name of the group |
Spoke Id string spokeId | The unique ID for the group, this can be the unique identifier for the group entity object within your application |
Users string users | An array of Rippling IDs that will be in the group |
Post Mark App Installed
Mark App Installed | key: postMarkAppInstalled
| Input | Notes |
|---|---|
Connection connection / Required connection |
Process Leave Requests
POST Process Leave Request | key: processLeaveRequests
| Input | Notes |
|---|---|
Action string / Required action | The action to be taken on the leave request |
Connection connection / Required connection | |
Id string / Required id | Unique identifier of the leave request being processed |
Put Groups Group Id
PUT Group | key: putGroupsGroupId
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Group Id string / Required groupId | Unique identifier for the group within Rippling |
Name string name | The name of the Group |
Spoke Id string spokeId | The external identifier of the Group |
Users string users | The array of users within the Group |
Version string version | The version identifier of the Group |
Raw Request
Send raw HTTP request to Rippling | key: rawRequest
| Input | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connection | |||
Data string 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 boolean debugRequest | false | Enabling this flag will log out the current request. | |
File Data string Key Value List fileData | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] | |
Form Data string Key Value List formData | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] | |
Header string Key Value List headers | A list of headers to send with the request. | User-Agent: curl/7.64.1 | |
Max Retry Count string maxRetries | 0 | The maximum number of retries to attempt. | |
Method string / Required method | The HTTP method to use. | ||
Query Parameter string Key Value List queryParams | 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 string / Required responseType | json | The type of data you expect in the response. You can request json, text, or binary data. | |
Retry On All Errors boolean retryAllErrors | false | If true, retries on all erroneous responses regardless of type. | |
Retry Delay (ms) string retryDelayMS | 0 | The delay in milliseconds between retries. | |
Timeout string timeout | The maximum time that a client will await a response to its request | 2000 | |
URL string / Required 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 boolean useExponentialBackoff | false | Specifies whether to use a pre-defined exponential backoff strategy for retries. |