Skip to main content

Rippling Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a Rippling location.
rippling_api.png

Rippling

Create a Rippling Destination​

  1. Click the + icon on the Nexset that will be sent to the Rippling destination, and select the Send to Destination option from the menu.

  2. Select the Rippling connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Rippling organization, and click Next; or, create a new Rippling credential for use in this flow.

  3. In Nexla, Rippling destinations can be created using pre-built endpoint templates, which expedite destination setup for common Rippling write operations. Each template is designed specifically for the corresponding Rippling endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    Rippling destinations can also be configured manually, allowing you to send data to Rippling endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Rippling endpoints. Each template is designed specifically for the corresponding Rippling endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Create Leave Request

    Submits a new leave request for a worker via the Rippling Platform API. Use this endpoint to programmatically create leave requests from external systems—for example, when automating leave management as part of an HR onboarding or scheduling workflow.

    • This endpoint uses an HTTP POST to https://api.rippling.com/platform/api/leave_requests. The request body is automatically constructed from the Nexset data in JSON format.

    • The request payload must include the following fields in the Nexset data being sent to this destination:

      • Role ID: The Rippling role ID of the worker for whom the leave request is being submitted. This corresponds to the worker's unique identifier in Rippling's HRIS system.
      • Leave Type ID: The ID of the leave type to apply (e.g., PTO, sick, parental). Use the List Leave Types endpoint to retrieve available leave type IDs for your company.
      • Start Date: The first day of the requested leave period, in yyyy-MM-dd format.
      • End Date: The last day of the requested leave period, in yyyy-MM-dd format.
    • No additional template-level parameters are required. All fields are passed as part of the Nexset data JSON body.

    Creating leave requests via the API requires that Rippling's Time & Attendance module is enabled for your company and that your API token includes the leave:write scope. The leave request will be created in a pending state and may require manager approval depending on your company's leave approval policy.

    Update Leave Request

    Updates an existing leave request by its unique ID via the Rippling Platform API using an HTTP PATCH request. Use this endpoint to modify leave request dates, hours, reason, or status from an external system as part of an automated HR workflow.

    • Enter the unique ID of the leave request to update in the Leave Request ID field. This is a required parameter. Leave request IDs can be retrieved using the List Leave Requests source endpoint. The ID is appended to the Platform API URL path to target the specific leave record.

    • The request body is automatically constructed from the Nexset data in JSON format. Include only the fields you want to modify—the PATCH method applies partial updates, so omitted fields retain their current values in Rippling.

    • Fields that can be updated via PATCH include:

      • Start Date: Updated start date for the leave period, in yyyy-MM-dd format.
      • End Date: Updated end date for the leave period, in yyyy-MM-dd format.
      • Hours: Updated leave duration in hours.
      • Reason: Updated reason or notes for the leave request.
      • Status: Updated approval status, where applicable.

    Only leave requests in an editable state can be updated via the API. Approved or finalized leave requests may be locked for editing depending on your company's Rippling configuration. Verify that the leave request is in a modifiable state before sending an update payload.

Configure Manually​

Rippling destinations can be manually configured to send data to any valid Rippling REST or Platform API endpoint. Manual configuration provides maximum flexibility for write operations not covered by pre-built templates.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Rippling API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Rippling API from the Method pulldown menu. Common methods for Rippling write operations include:

    • POST: For creating new resources (e.g., new leave requests, new records).
    • PATCH: For partially updating an existing resource using its ID (e.g., updating a leave request's dates or status).
    • PUT: For fully replacing an existing resource.

Data Format​

  1. Select the format in which the Nexset data will be sent to the Rippling API from the Content Format pulldown menu. Rippling APIs accept JSON format. Nexla will automatically serialize the Nexset data to JSON for each API call.

API Endpoint URL​

  1. Enter the URL of the Rippling API endpoint to which you want to send the Nexset data in the URL field. Rippling provides two base API surfaces:

    • REST API: https://rest.ripplingapis.com/{endpoint}
    • Platform API: https://api.rippling.com/platform/api/{endpoint}

    For update operations (PATCH/PUT), include the unique ID of the record to be updated at the end of the URL path, for example: https://api.rippling.com/platform/api/leave_requests/{leave_request_id}.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include the Authorization or Content-Type headers—these are handled automatically by the Rippling credential and the selected data format, respectively.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Rippling destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings.

Response Webhook​

Optional

Nexla can automatically send the response received from the Rippling API after each call to a new Nexla webhook data source. This option allows you to track the status of each API call, capture Rippling-assigned IDs for newly created records, and process any additional information returned by the API.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the Rippling API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the Rippling API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Rippling API using the current settings.

Save & Activate the Destination​

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To activate data delivery to Rippling, open the destination resource menu and select Activate.

    Data will not be sent to Rippling until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.