Skip to main content

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.

Rippling Connections#

OAuth 2.0#

To use OAuth 2.0 with Rippling you will need to coordinate with them in accordance with their Partner Requirements.

Ensure to supply Prismatic's callback URL: 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 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.

InputDefaultNotesExample
Input
Authorization URL
string
/ Required
Default
Notes
Authorization URL from Rippling
Example
https://app.rippling/apps/PLATFORM/{AppName}
Input
Client ID
string
/ Required
Default
Notes
Client identifier for your app supplied by Rippling
Example
 
Input
Client Secret
password
/ Required
Default
Notes
Client secret for your app supplied by Rippling
Example
 
Input
Scopes
string
/ Required
Default
Notes
Space-delimited scopes
Example
 
Input
Token URL
string
/ Required
Hidden Field
Default
https://app.rippling.com/api/o/token/
Notes
Token URL
Example
 

Bearer API Key#

InputNotes
Input
Authorization
password
/ Required
Notes
 

Actions#

Delete Groups Group Id#

DELETE Group | key: deleteGroupsGroupId

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Group Id
string
/ Required
Notes
Unique identifier for the group within Rippling

Get Companies#

GET Current Company | key: getCompanies

InputNotes
Input
Connection
connection
/ Required
Notes
 

Get Company Activity#

GET Company Activity | key: getCompanyActivity

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
End Date
string
Notes
Timestamp to list activity before (inclusive)
Input
Limit
string
Notes
Specifies the number of results to page (maximum: 1000) (default: 1000)
Input
Next
string
Notes
Specifies the pagination cursor to the next page
Input
Start Date
string
Notes
Timestamp to list activity after (inclusive)

Get Custom Fields#

GET Custom Fields | key: getCustomFields

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Limit
string
Notes
Sets a limit on the returned values
Input
Offset
string
Notes
Offsets the returned values

Get Departments#

GET Departments | key: getDepartments

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Limit
string
Notes
Sets a limit on the returned values
Input
Offset
string
Notes
Offsets the returned values

Get Employees#

GET Employees | key: getEmployees

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Limit
string
Notes
Sets a limit on the returned values
Input
Offset
string
Notes
Offsets the returned values

Get Employees Employee Id#

GET Employee | key: getEmployeesEmployeeId

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Employee Id
string
/ Required
Notes
Unique identifier for the employee within Rippling

Get Employees Include Terminated#

GET Employees (Including Terminated) | key: getEmployeesIncludeTerminated

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
EIN
string
Notes
Employer identification number, also known as the Federal Emplower Identification Number or the Federal Tax Identification Number
Input
Limit
string
Notes
Sets a limit on the returned values
Input
Offset
string
Notes
Offsets the returned values

Get Groups#

GET Groups | key: getGroups

InputNotes
Input
Connection
connection
/ Required
Notes
 

Get Leave Requests#

GET Leave Requests | key: getLeaveRequests

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
End Date
string
Notes
End date of leave
Input
From
string
Notes
Filter to capture whether the leave request overlaps with a date range
Input
Id
string
Notes
 
Input
Leave Policy
string
Notes
 
Input
Processed By
string
Notes
 
Input
Requested By
string
Notes
 
Input
Role
string
Notes
 
Input
Start Date
string
Notes
Start date of leave
Input
Status
string
Notes
 
Input
To
string
Notes
Filter to capture whether the leave request overlaps with a date range

Get Levels#

GET Levels | key: getLevels

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Limit
string
Notes
Sets a limit on the returned values
Input
Offset
string
Notes
Offsets the returned values

Get Me#

GET Current User | key: getMe

InputNotes
Input
Connection
connection
/ Required
Notes
 

Get Saml Idp Metadata#

GET SAML Metadata | key: getSamlIdpMetadata

InputNotes
Input
Connection
connection
/ Required
Notes
 

Get Teams#

GET Teams | key: getTeams

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Limit
string
Notes
Sets a limit on the returned values
Input
Offset
string
Notes
Offsets the returned values

Get Work Locations#

GET Work Locations | key: getWorkLocations

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Limit
string
Notes
Sets a limit on the returned values
Input
Offset
string
Notes
Offsets the returned values

Patch Groups Group Id#

PATCH Group | key: patchGroupsGroupId

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Group Id
string
/ Required
Notes
Unique identifier for the group within Rippling
Input
Name
string
Notes
The name of the Group
Input
Spoke Id
string
Notes
The external identifier of the Group
Input
Users
string
Notes
The array of users within the Group
Input
Version
string
Notes
The version identifier of the Group

Post Ats Candidates Push Candidate#

POST New Candidate | key: postAtsCandidatesPushCandidate

InputNotes
Input
Attachments
string
Notes
 
Input
Candidate Id
string
Notes
The unique identifier of the candidate from the ATS
Input
Connection
connection
/ Required
Notes
 
Input
Currency
string
Notes
A string field of the ofifcial currency doe as listed in ISO 4217
Input
Department
string
Notes
The department name as a string
Input
Email
string
Notes
The candidate's email
Input
Employment Type
string
Notes
The ENUM type of employment the user will have within Rippling
Input
Equity Shares
string
Notes
The number of shares that will be given to the candidate
Input
Job Title
string
Notes
The candidate's job title
Input
Name
string
Notes
The candidate's name
Input
Phone Number
string
Notes
The candidate's phone number
Input
Salary Per Unit
string
Notes
The decimal value that the candidate gets paid every salaryUnit time period
Input
Salary Unit
string
Notes
An ENUM string value, denoting the frequency at which the candidate should be paid once the role begins
Input
Signing Bonus
string
Notes
The bonus cash given to the candidate as a part of a one time payment, with two decimal digit precision
Input
Start Date
string
Notes
The would-be start date of the candidate

Post Groups#

POST Groups | key: postGroups

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Name
string
Notes
User-readable name of the group
Input
Spoke Id
string
Notes
The unique ID for the group, this can be the unique identifier for the group entity object within your application
Input
Users
string
Notes
An array of Rippling IDs that will be in the group

Post Mark App Installed#

Mark App Installed | key: postMarkAppInstalled

InputNotes
Input
Connection
connection
/ Required
Notes
 

Process Leave Requests#

POST Process Leave Request | key: processLeaveRequests

InputNotes
Input
Action
string
/ Required
Notes
The action to be taken on the leave request
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
Unique identifier of the leave request being processed

Put Groups Group Id#

PUT Group | key: putGroupsGroupId

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Group Id
string
/ Required
Notes
Unique identifier for the group within Rippling
Input
Name
string
Notes
The name of the Group
Input
Spoke Id
string
Notes
The external identifier of the Group
Input
Users
string
Notes
The array of users within the Group
Input
Version
string
Notes
The version identifier of the Group

Raw Request#

Issue a raw HTTP request | key: rawRequest

InputDefaultNotesExample
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Data
string
Default
Notes
The HTTP body payload to send to the URL. Must be a string or a reference to output from a previous step.
Example
{"exampleKey": "Example Data"}
Input
Debug Request
boolean
Default
false
Notes
Enabling this flag will log out the current request.
Example
 
Input
File Data
string
Key Value List
Default
Notes
File Data to be sent as a multipart form upload.
Example
[{key: "example.txt", value: "My File Contents"}]
Input
Form Data
string
Key Value List
Default
Notes
The Form Data to be sent as a multipart form upload.
Example
[{"key": "Example Key", "value": new Buffer("Hello World")}]
Input
Header
string
Key Value List
Default
Notes
A list of headers to send with the request.
Example
User-Agent: curl/7.64.1
Input
Max Retry Count
string
Default
0
Notes
The maximum number of retries to attempt.
Example
 
Input
Method
string
/ Required
Default
Notes
The HTTP method to use.
Example
 
Input
Query Parameter
string
Key Value List
Default
Notes
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.
Example
 
Input
Response Type
string
/ Required
Default
json
Notes
The type of data you expect in the response. You can request json, text, or binary data.
Example
 
Input
Retry On All Errors
boolean
Default
false
Notes
If true, retries on all erroneous responses regardless of type.
Example
 
Input
Retry Delay (ms)
string
Default
0
Notes
The delay in milliseconds between retries.
Example
 
Input
Timeout
string
Default
Notes
The maximum time that a client will await a response to its request
Example
2000
Input
URL
string
/ Required
Default
Notes
This is the URL to call.
Example
/sobjects/Account
Input
Use Exponential Backoff
boolean
Default
false
Notes
Specifies whether to use a pre-defined exponential backoff strategy for retries.
Example