RWS Docs

This guide walks you through creating a working integration that extracts employee data from an RWS Connect table and delivers it in CSV format to an SFTP server. By the end, you’ll know how to query Connect tables, including keeping only the latest record per employee, and use the result like any other API source.

What you’ll build

You’ll create an integration that:

Extracts the current employee snapshot from an RWS Connect table
Transforms the data to a simpler format
Loads the results to an SFTP server in CSV format

Time required: approximately 5 minutes.

Prerequisites

Access to an RWS Integration Workspace
An RWS Connect table already provisioned, and the x-api-key provided by RWS (to request one, see RWS Connect)
A SFTP server

The examples use a tenant acme with a table employees. Replace them with your own database and table names.

Step 1: Create the source Connection

The RWS Connect API uses a standard Simple connection.

In the sidebar, click Connections
Click New Connection
Configure the connection:

Field	Value
Name	`RWS Connect`
Type	`API`
URL	`https://connect.rwsintegration.com`
Base Path	`/`
Authentication	`Simple`
Headers	`x-api-key`: the key provided by RWS

Click Save

Step 2: Create the destination Connection

Now create a Connection for your SFTP server.

Click New Connection
Configure the connection:

Field	Value
Name	`SFTP Connection`
Type	`SFTP`
URL	`sftp.example.com`
Base Path	`/uploads`
Port	`22`
Username	`username`
SSH Private Key	`private_key`

Click Save

Step 3: Create the Integration

With both Connections ready, create the Integration that moves data between them.

In the sidebar, click Integrations
Click New Integration

General settings

Configure the basic integration properties:

Field	Value
Name	`Employees from RWS Connect`
Version	`1.0.0`
Type	`Full`
Environment	`Staging`
Schedule	Daily, at a time of your choice (e.g. `09:00`)

Extract phase

The Extract phase queries the RWS Connect API.

Expand the Extract section
Configure these fields:

Field	Value
Connection	`RWS Connect`
Method	`GET`
Path	`/`

Add the Query Params:

Parameter	Value
`database`	`acme`
`table`	`employees`
`filter[over_employee_id][extracted_at]`	`first`

The filter[over_employee_id][extracted_at]=first parameter keeps only the newest record per employee. Connect tables preserve a snapshot per run, and this filter turns the history into the current state. See Querying the RWS Connect API for details.

Set the Datapoint Path in Response to Items
Set the Pagination:

Field	Value
Pagination Type	`Simple`
Page size parameter	`page[size]`
Page size value	`100`
Initial page parameter	`page[number]`
Initial page value	`1`
Pagination end type	`Object`

Check the Extract Preview panel on the right side. It should show:

Status: 200 OK
A single employee record (the Datapoint) like this:

{
  "employee_id": "1042",
  "name": "Ana Souza",
  "department": "Sales",
  "city": "Manaus",
  "extracted_at": "2026-07-28 06:00:12.000"
}

Transform phase

The Transform phase maps source fields to your destination format. For this guide, create a simple mapping with three fields.

Expand the Transform section
Click Add Transformation and configure:

Type	To	From
Simple	`employeeId`	`employee_id`
Simple	`fullName`	`name`
Simple	`department`	`department`

Check the Transform Preview panel. It should display:

{
  "employeeId": "1042",
  "fullName": "Ana Souza",
  "department": "Sales"
}

Load phase

The Load phase sends transformed data to your destination.

Expand the Load section
Configure these fields:

Field	Value
Connection	`SFTP Connection`
Path	`/guides`
File name	`employees.csv`

Step 4: Deploy the Integration

Toggle Deployment to enabled
Click Create Integration

The integration will now run automatically every day at the time you chose.

Step 5: Run it now

You don’t need to wait for the schedule. Trigger the first run manually:

Open your integration from the Integrations list
Click Run now, next to the Save button
Confirm in the dialog, and a Run started message appears

Step 6: Verify the results

Go to your SFTP server and check if the file employees.csv was created in the /guides directory. You should see a file with this structure:

employeeId,fullName,department
1042,Ana Souza,Sales
1043,Bruno Lima,Finance
1044,Carla Mendes,Operations

Congratulations, you’ve built an integration on top of an RWS Connect table!

What you learned

RWS Connect tables are queried through a standard Simple connection, with no special connector needed
database and table identify your data: the tenant name from onboarding and the table agreed when the connector was requested
The over_ filter turns snapshot history into the current state, keeping the newest record per key
Items and Simple pagination (page[size] / page[number]) plug straight into the platform’s extract configuration

Need the data live?

This guide reads from Connect tables — your data as of the last refresh. When an integration needs your system’s answer right now (monitoring and audits, for example), use RWS Connect Live: the same api key, reading your system in real time.

Next steps

Querying the RWS Connect API

Filters, aggregations, sorting and everything else the API supports

Dynamic Parameters

Filter by dynamic dates like “yesterday”

Business Rules

Transform data with JavaScript

Scheduling

Schedule your integrations to run automatically

Getting Started

Guides

Core Concepts

Extract from RWS Connect

What you’ll build

Prerequisites

Step 1: Create the source Connection

Step 2: Create the destination Connection

Step 3: Create the Integration

General settings

Extract phase

Transform phase

Load phase

Step 4: Deploy the Integration

Step 5: Run it now

Step 6: Verify the results

What you learned

Need the data live?

Next steps

Querying the RWS Connect API

Dynamic Parameters

Business Rules

Scheduling

​What you’ll build

​Prerequisites

​Step 1: Create the source Connection

​Step 2: Create the destination Connection

​Step 3: Create the Integration

​General settings

​Extract phase

​Transform phase

​Load phase

​Step 4: Deploy the Integration

​Step 5: Run it now

​Step 6: Verify the results

​What you learned

​Need the data live?

​Next steps

Querying the RWS Connect API

Dynamic Parameters

Business Rules

Scheduling

What you’ll build

Prerequisites

Step 1: Create the source Connection

Step 2: Create the destination Connection

Step 3: Create the Integration

General settings

Extract phase

Transform phase

Load phase

Step 4: Deploy the Integration

Step 5: Run it now

Step 6: Verify the results

What you learned

Need the data live?

Next steps