Skip to main content

​
Create draft hires

Action ID: tools.rippling.create_draft_hires Create draft hires. Calls POST /draft-hires/ directly. Bulk onboarding entry point. The request body takes a draft_hires array. Required scope: draft-hires.read-write. Reference: https://developer.rippling.com/documentation/rest-api/reference/create-draft-hires

​
Secrets

Required secrets:
  • rippling: required values RIPPLING_API_KEY.

​
Input fields

​
string | null
Base URL of the Rippling REST API.Default: null.
​
object | null
API-native query parameters.Default: null.
​
object | null
API-native request body passed through without validation.Default: null.

​
Create software deployment

Action ID: tools.rippling.create_software_deployment Create software deployment. Calls POST /software-deployments/ directly. Deploys a SaaS app to a group or device group. Required scope: software-deployments.read-write. Reference: https://developer.rippling.com/documentation/rest-api/reference/create-software-deployments

​
Secrets

Required secrets:
  • rippling: required values RIPPLING_API_KEY.

​
Input fields

​
string | null
Base URL of the Rippling REST API.Default: null.
​
object | null
API-native query parameters.Default: null.
​
object | null
API-native request body passed through without validation.Default: null.

​
Delete software deployment

Action ID: tools.rippling.delete_software_deployment Delete software deployment. Calls DELETE /software-deployments/{id}/ directly. Destructive. Removes the deployment and revokes the app for every member of the target group. Required scope: software-deployments.read-write. Reference: https://developer.rippling.com/documentation/rest-api/reference/delete-software-deployments

​
Secrets

Required secrets:
  • rippling: required values RIPPLING_API_KEY.

​
Input fields

​
string
required
Rippling API path value for id.
​
string | null
Base URL of the Rippling REST API.Default: null.
​
object | null
API-native query parameters.Default: null.

​
Get report run

Action ID: tools.rippling.get_report_run Get report run. Calls GET /report-runs/{run_id}/ directly. Retrieves the status and, once complete, the output of a report run started by trigger_report_run. Requires the Reports API entitlement. Required scope: report-runs.read. Reference: https://developer.rippling.com/documentation/rest-api/reference/get-report-runs

​
Secrets

Required secrets:
  • rippling: required values RIPPLING_API_KEY.

​
Input fields

​
string
required
Rippling API path value for run_id.
​
string | null
Base URL of the Rippling REST API.Default: null.
​
object | null
API-native query parameters.Default: null.

​
Get SSO me

Action ID: tools.rippling.get_sso_me Get SSO me. Calls GET /sso-me/ directly. Returns a single object, not a paginated collection, despite Rippling naming the endpoint list-sso-me. Cheapest call for verifying that the configured API token is valid: a 401 means the token is revoked or expired and a 403 means a scope is missing. Required scope: sso-me.read. Reference: https://developer.rippling.com/documentation/rest-api/reference/list-sso-me

​
Secrets

Required secrets:
  • rippling: required values RIPPLING_API_KEY.

​
Input fields

​
string | null
Base URL of the Rippling REST API.Default: null.
​
object | null
API-native query parameters.Default: null.

​
Get worker

Action ID: tools.rippling.get_worker Get worker. Calls GET /workers/{id}/ directly. Fetches a single worker by Rippling worker id, for when you already have that id from list_workers or an upstream event. Required scope: workers.read. Reference: https://developer.rippling.com/documentation/rest-api/reference/get-workers

​
Secrets

Required secrets:
  • rippling: required values RIPPLING_API_KEY.

​
Input fields

​
string
required
Rippling API path value for id.
​
string | null
Base URL of the Rippling REST API.Default: null.
​
object | null
API-native query parameters.Default: null.

​
List app users

Action ID: tools.rippling.list_app_users List app users. Calls GET /app-users/ directly. Links each worker to their external SaaS account. A push_state of DELETE_FAILED or SUSPEND_FAILED means access was not actually revoked, and a match_state of NOT_MATCHED surfaces orphaned accounts. Required scope: app-users.read. Reference: https://developer.rippling.com/documentation/rest-api/reference/list-app-users

​
Secrets

Required secrets:
  • rippling: required values RIPPLING_API_KEY.

​
Input fields

​
string | null
Base URL of the Rippling REST API.Default: null.
​
object | null
API-native query parameters, including cursor for pagination. Support for filter, expand, and order_by varies by endpoint; see the linked Rippling documentation.Default: null.

​
List departments

Action ID: tools.rippling.list_departments List departments. Calls GET /departments/ directly. Departments are the org-chart reporting units carried on each worker record. Required scope: departments.read. Reference: https://developer.rippling.com/documentation/rest-api/reference/list-departments

​
Secrets

Required secrets:
  • rippling: required values RIPPLING_API_KEY.

​
Input fields

​
string | null
Base URL of the Rippling REST API.Default: null.
​
object | null
API-native query parameters, including cursor for pagination. Support for filter, expand, and order_by varies by endpoint; see the linked Rippling documentation.Default: null.

​
List devices

Action ID: tools.rippling.list_devices List devices. Calls GET /devices/ directly. Filter on worker_id for offboarding device recovery, or on lifecycle_state and enrollment_status for fleet compliance. Required scope: devices.read. Reference: https://developer.rippling.com/documentation/rest-api/reference/list-devices

​
Secrets

Required secrets:
  • rippling: required values RIPPLING_API_KEY.

​
Input fields

​
string | null
Base URL of the Rippling REST API.Default: null.
​
object | null
API-native query parameters, including cursor for pagination. Support for filter, expand, and order_by varies by endpoint; see the linked Rippling documentation.Default: null.

​
List entitlements

Action ID: tools.rippling.list_entitlements List entitlements. Calls GET /entitlements/ directly. Reports which API entitlements the company has, so a workflow can branch before calling an entitlement-gated action. Required scope: entitlements.read. Reference: https://developer.rippling.com/documentation/rest-api/reference/list-entitlements

​
Secrets

Required secrets:
  • rippling: required values RIPPLING_API_KEY.

​
Input fields

​
string | null
Base URL of the Rippling REST API.Default: null.
​
object | null
API-native query parameters, including cursor for pagination. Support for filter, expand, and order_by varies by endpoint; see the linked Rippling documentation.Default: null.

​
List leave balances

Action ID: tools.rippling.list_leave_balances List leave balances. Calls GET /leave-balances/ directly. Balances are point-in-time accrued and available time per leave policy; use list_leave_requests for individual time-off records. Required scope: leave-balances.read. Reference: https://developer.rippling.com/documentation/rest-api/reference/list-leave-balances

​
Secrets

Required secrets:
  • rippling: required values RIPPLING_API_KEY.

​
Input fields

​
string | null
Base URL of the Rippling REST API.Default: null.
​
object | null
API-native query parameters, including cursor for pagination. Support for filter, expand, and order_by varies by endpoint; see the linked Rippling documentation.Default: null.

​
List leave requests

Action ID: tools.rippling.list_leave_requests List leave requests. Calls GET /leave-requests/ directly. Each record is one time-off request with an approval status; pass its id to update_leave_request to approve, reject, or cancel it. Required scope: leave-requests.read. Reference: https://developer.rippling.com/documentation/rest-api/reference/list-leave-requests

​
Secrets

Required secrets:
  • rippling: required values RIPPLING_API_KEY.

​
Input fields

​
string | null
Base URL of the Rippling REST API.Default: null.
​
object | null
API-native query parameters, including cursor for pagination. Support for filter, expand, and order_by varies by endpoint; see the linked Rippling documentation.Default: null.

​
List software deployments

Action ID: tools.rippling.list_software_deployments List software deployments. Calls GET /software-deployments/ directly. Shows which SaaS app is deployed to which group or device group. Required scope: software-deployments.read. Reference: https://developer.rippling.com/documentation/rest-api/reference/list-software-deployments

​
Secrets

Required secrets:
  • rippling: required values RIPPLING_API_KEY.

​
Input fields

​
string | null
Base URL of the Rippling REST API.Default: null.
​
object | null
API-native query parameters, including cursor for pagination. Support for filter, expand, and order_by varies by endpoint; see the linked Rippling documentation.Default: null.

​
List supergroup members

Action ID: tools.rippling.list_supergroup_members List supergroup members. Calls GET /supergroups/{group_id}/members/ directly. Returns effective membership, including members inherited from rules. Required scope: supergroups.read. Reference: https://developer.rippling.com/documentation/rest-api/reference/list-supergroups-group-id-members

​
Secrets

Required secrets:
  • rippling: required values RIPPLING_API_KEY.

​
Input fields

​
string
required
Rippling API path value for group_id.
​
string | null
Base URL of the Rippling REST API.Default: null.
​
object | null
API-native query parameters, including cursor for pagination. Support for filter, expand, and order_by varies by endpoint; see the linked Rippling documentation.Default: null.

​
List supergroups

Action ID: tools.rippling.list_supergroups List supergroups. Calls GET /supergroups/ directly. Supergroups drive app access policies. Required scope: supergroups.read. Reference: https://developer.rippling.com/documentation/rest-api/reference/list-supergroups

​
Secrets

Required secrets:
  • rippling: required values RIPPLING_API_KEY.

​
Input fields

​
string | null
Base URL of the Rippling REST API.Default: null.
​
object | null
API-native query parameters, including cursor for pagination. Support for filter, expand, and order_by varies by endpoint; see the linked Rippling documentation.Default: null.

​
List teams

Action ID: tools.rippling.list_teams List teams. Calls GET /teams/ directly. Teams group workers independently of the department reporting line, so one worker can belong to several. Required scope: teams.read. Reference: https://developer.rippling.com/documentation/rest-api/reference/list-teams

​
Secrets

Required secrets:
  • rippling: required values RIPPLING_API_KEY.

​
Input fields

​
string | null
Base URL of the Rippling REST API.Default: null.
​
object | null
API-native query parameters, including cursor for pagination. Support for filter, expand, and order_by varies by endpoint; see the linked Rippling documentation.Default: null.

​
List users

Action ID: tools.rippling.list_users List users. Calls GET /users/ directly. Join to workers on worker.user_id. The user number field is the stable cross-system employee identifier. Required scope: users.read. Reference: https://developer.rippling.com/documentation/rest-api/reference/list-users

​
Secrets

Required secrets:
  • rippling: required values RIPPLING_API_KEY.

​
Input fields

​
string | null
Base URL of the Rippling REST API.Default: null.
​
object | null
API-native query parameters, including cursor for pagination. Support for filter, expand, and order_by varies by endpoint; see the linked Rippling documentation.Default: null.

​
List work locations

Action ID: tools.rippling.list_work_locations List work locations. Calls GET /work-locations/ directly. Work locations are the work sites the company has registered, used for tax and compliance reporting. Required scope: work-locations.read. Reference: https://developer.rippling.com/documentation/rest-api/reference/list-work-locations

​
Secrets

Required secrets:
  • rippling: required values RIPPLING_API_KEY.

​
Input fields

​
string | null
Base URL of the Rippling REST API.Default: null.
​
object | null
API-native query parameters, including cursor for pagination. Support for filter, expand, and order_by varies by endpoint; see the linked Rippling documentation.Default: null.

​
List worker changes

Action ID: tools.rippling.list_worker_changes List worker changes. Calls GET /worker-changes/ directly. Audit trail of changes to worker fields. Requires the Worker Changes API entitlement. Required scope: worker-changes.read. Reference: https://developer.rippling.com/documentation/rest-api/reference/list-worker-changes

​
Secrets

Required secrets:
  • rippling: required values RIPPLING_API_KEY.

​
Input fields

​
string | null
Base URL of the Rippling REST API.Default: null.
​
object | null
API-native query parameters, including cursor for pagination. Support for filter, expand, and order_by varies by endpoint; see the linked Rippling documentation.Default: null.

​
List workers

Action ID: tools.rippling.list_workers List workers. Calls GET /workers/ directly. Filter on status to select the active roster, terminated workers, or the pre-start pipeline. Required scope: workers.read. Reference: https://developer.rippling.com/documentation/rest-api/reference/list-workers

​
Secrets

Required secrets:
  • rippling: required values RIPPLING_API_KEY.

​
Input fields

​
string | null
Base URL of the Rippling REST API.Default: null.
​
object | null
API-native query parameters, including cursor for pagination. Support for filter, expand, and order_by varies by endpoint; see the linked Rippling documentation.Default: null.

​
Trigger report run

Action ID: tools.rippling.trigger_report_run Trigger report run. Calls POST /report-runs/ directly. Starts an asynchronous run of a saved Rippling report. Poll get_report_run with the returned run id to collect results. Requires the Reports API entitlement. Required scope: report-runs.read-write. Reference: https://developer.rippling.com/documentation/rest-api/reference/trigger-report-runs

​
Secrets

Required secrets:
  • rippling: required values RIPPLING_API_KEY.

​
Input fields

​
string | null
Base URL of the Rippling REST API.Default: null.
​
object | null
API-native query parameters.Default: null.
​
object | null
API-native request body passed through without validation.Default: null.

​
Update leave request

Action ID: tools.rippling.update_leave_request Update leave request. Calls PATCH /leave-requests/{id}/ directly. Set status in the request body to approve, reject, or cancel a request. Required scope: leave-requests.read-write. Reference: https://developer.rippling.com/documentation/rest-api/reference/update-leave-requests

​
Secrets

Required secrets:
  • rippling: required values RIPPLING_API_KEY.

​
Input fields

​
string
required
Rippling API path value for id.
​
string | null
Base URL of the Rippling REST API.Default: null.
​
object | null
API-native query parameters.Default: null.
​
object | null
API-native request body passed through without validation.Default: null.

​
Update supergroup exclusion members

Action ID: tools.rippling.update_supergroup_exclusion_members Update supergroup exclusion members. Calls PATCH /supergroups/{group_id}/exclusion-members/ directly. Force-revokes group-driven access. Takes a SCIM-style Operations array in the request body. Required scope: supergroups.read-write. Reference: https://developer.rippling.com/documentation/rest-api/reference/update-supergroups-group-id-exclusion-members

​
Secrets

Required secrets:
  • rippling: required values RIPPLING_API_KEY.

​
Input fields

​
string
required
Rippling API path value for group_id.
​
string | null
Base URL of the Rippling REST API.Default: null.
​
object | null
API-native query parameters.Default: null.
​
object | null
API-native request body passed through without validation.Default: null.

​
Update supergroup inclusion members

Action ID: tools.rippling.update_supergroup_inclusion_members Update supergroup inclusion members. Calls PATCH /supergroups/{group_id}/inclusion-members/ directly. Grants group-driven access. Takes a SCIM-style Operations array in the request body. Required scope: supergroups.read-write. Reference: https://developer.rippling.com/documentation/rest-api/reference/update-supergroups-group-id-inclusion-members

​
Secrets

Required secrets:
  • rippling: required values RIPPLING_API_KEY.

​
Input fields

​
string
required
Rippling API path value for group_id.
​
string | null
Base URL of the Rippling REST API.Default: null.
​
object | null
API-native query parameters.Default: null.
​
object | null
API-native request body passed through without validation.Default: null.