Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Rippling

Scalekit connector
Open markdown

The Rippling connector lets your AI agent act in each user's Rippling account. Each user connects their own Rippling access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 29 tools.

Tools
29
What they doRead · write · destructive
23 · 6 · 023 read6 write0 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the Rippling connection

    In AgentKit > Connections, create a Rippling connection. The name you give it is the connection_name your code passes. See Configure connections.

  4. Authorize a user and make your first call

    quickstart.mts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    import { createInterface } from 'node:readline/promises'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENVIRONMENT_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    const connector = 'rippling'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Rippling:', link)
    const rl = createInterface({ input: process.stdin, output: process.stdout })
    await rl.question('Press Enter after authorizing...')
    rl.close()
    // Make your first call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'rippling_current_user_get',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their Rippling credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • rippling_company_listList the Rippling company the API token belongs to.Read-only

    List Companies

    List the Rippling company the API token belongs to. Returns the company with id, name, legal name, doing-business-as name, primary email, phone, addresses and its legal entity structure. Use this to read the company record or confirm which company the connection is bound to. Use rippling_current_user_get for the token owner.

    Inputs

    cursorstring
    Pagination cursor for the companies list. Leave empty for the first page. For the next page, take the cursor query parameter from the previous response's next_link; when next_link is null there are no more pages. Example: cD01ODNmZDg5MDA1ZWQyMzNmOGYxZGY0Zjk=.
    expandstring
    Comma-separated related objects to return inline instead of only their IDs. Allowed: parent_legal_entity, legal_entities. Example: legal_entities.
    limitinteger
    Maximum number of companies to return in one page, from 1 to 100. Defaults to 50. Example: 50.default 50
    order_bystring
    Sort order: id, created_at or updated_at, optionally followed by asc or desc (ascending is the default). Separate several fields with commas. Example: created_at desc.
  • rippling_current_user_getGet the Rippling identity behind the connected API token.Read-only

    Get Current User

    Get the Rippling identity behind the connected API token. Returns the token owner's id, work email and company id, and the company when expanded. Use this to find out who the connection acts as. Use rippling_user_get for any other user.

    Inputs

    expandstring
    Comma-separated related objects to return inline instead of only their IDs. Allowed: company. Example: company.
  • rippling_custom_field_listList the custom fields defined in the Rippling company.Read-only

    List Custom Fields

    List the custom fields defined in the Rippling company. Returns a page of custom fields with id, name, description, type, whether it is required, and its options, plus next_link for the next page. Use this to learn which custom fields exist and what their values mean.

    Inputs

    cursorstring
    Pagination cursor for the custom fields list. Leave empty for the first page. For the next page, take the cursor query parameter from the previous response's next_link; when next_link is null there are no more pages. Example: cD01ODNmZDg5MDA1ZWQyMzNmOGYxZGY0Zjk=.
    limitinteger
    Maximum number of custom fields to return in one page, from 1 to 100. Defaults to 50. Example: 50.default 50
    order_bystring
    Sort order: id, created_at or updated_at, optionally followed by asc or desc (ascending is the default). Separate several fields with commas. Example: created_at desc.
  • rippling_department_getGet one Rippling department by ID.Read-only

    Get Department

    Get one Rippling department by ID. Returns the department's name, parent id, reference code and department hierarchy, and the expanded parent when asked. Use this when you have a department ID. Use rippling_department_list to browse departments.

    Inputs

    department_idstringrequired
    The ID of the department to retrieve. Get it from rippling_department_list. Example: 66fb9df422242346857e04a1.
    expandstring
    Comma-separated related objects to return inline instead of only their IDs. Allowed: parent, department_hierarchy. Example: parent.
  • rippling_department_listList departments in the Rippling company.Read-only

    List Departments

    List departments in the Rippling company. Returns a page of departments with id, name, parent id, reference code and department hierarchy, plus next_link for the next page. Use this to find a department ID. Use rippling_department_get for one department.

    Inputs

    cursorstring
    Pagination cursor for the departments list. Leave empty for the first page. For the next page, take the cursor query parameter from the previous response's next_link; when next_link is null there are no more pages. Example: cD01ODNmZDg5MDA1ZWQyMzNmOGYxZGY0Zjk=.
    expandstring
    Comma-separated related objects to return inline instead of only their IDs. Allowed: parent, department_hierarchy. Example: parent.
    limitinteger
    Maximum number of departments to return in one page, from 1 to 100. Defaults to 50. Example: 50.default 50
    order_bystring
    Sort order: id, created_at or updated_at, optionally followed by asc or desc (ascending is the default). Separate several fields with commas. Example: created_at desc.
  • rippling_leave_balance_getGet one Rippling leave balance by ID.Read-only

    Get Leave Balance

    Get one Rippling leave balance by ID. Returns the worker id, leave type id and the remaining balance with and without future approved leave. Use this when you have a leave balance ID. Use rippling_leave_balance_list to find balances by worker or leave type.

    Inputs

    leave_balance_idstringrequired
    The ID of the leave balance to retrieve. Get it from rippling_leave_balance_list. Example: 66fb9df422242346857e0507.
    expandstring
    Comma-separated related objects to return inline instead of only their IDs. Allowed: worker, leave_type. Example: leave_type.
  • rippling_leave_balance_listList workers' remaining time off per leave type in Rippling, optionally filtered by worker or leave type.Read-only

    List Leave Balances

    List workers' remaining time off per leave type in Rippling, optionally filtered by worker or leave type. Returns a page of leave balances with id, worker id, leave type id and the remaining balance with and without future approved leave, plus next_link for the next page. Use this to check how much time off a worker has. Use rippling_leave_balance_get for one balance by ID.

    Inputs

    cursorstring
    Pagination cursor for the leave balances list. Leave empty for the first page. For the next page, take the cursor query parameter from the previous response's next_link; when next_link is null there are no more pages. Example: cD01ODNmZDg5MDA1ZWQyMzNmOGYxZGY0Zjk=.
    expandstring
    Comma-separated related objects to return inline instead of only their IDs. Allowed: worker, leave_type. Example: leave_type.
    filterstring
    Filter expression using the operators eq, ne, gt, ge, lt, le, in, and, or, with string values in single quotes. Filterable fields: worker_id, leave_type_id. Example: worker_id eq '66fb9df122242346857e0458'.
    limitinteger
    Maximum number of leave balances to return in one page, from 1 to 100. Defaults to 50. Example: 50.default 50
    order_bystring
    Sort order: id, created_at or updated_at, optionally followed by asc or desc (ascending is the default). Separate several fields with commas. Example: created_at desc.
  • rippling_leave_request_getGet one Rippling time-off request by ID.Read-only

    Get Leave Request

    Get one Rippling time-off request by ID. Returns the worker id, status, start and end dates and times, leave type, comments, reviewer, minutes requested and days taken off. Use this when you have a leave request ID. Use rippling_leave_request_list to search requests.

    Inputs

    leave_request_idstringrequired
    The ID of the leave request to retrieve. Get it from rippling_leave_request_list. Example: 66a43405af71f094991bf94f.
    expandstring
    Comma-separated related objects to return inline instead of only their IDs. Allowed: worker, requester, leave_type, reviewer. Example: worker,leave_type.