Prerequisites

When setting up a connection via SFTP, you will need credentials which you will use when transferring data (i.e. a SSH public key).

We will provide you with the following:

Username
Connection information (address, port, directory)
Filename

Setting up your SFTP connection

A note on which data is shared

The first step in the connection flow will prompt you to select which data should be accessible in this integration.

For SFTP exports, you are responsible for selecting which data is included in the file you transfer.

In that first step, you'll find an overview of the data points that need to be provided in your file export. You can toggle OFF potential data fields if you don't want to include them. Please make sure that all the required data fields are included in your export file.

Connection steps

Select the type of credential that your SFTP client will be using to transfer data. If the option you are using is not listed, select Option not listed, and we will try to support the method.
Select whether your HR system will encrypt the files before uploading. If you select PGP encryption, you will receive the public key to encrypt your files in Step 3.
Generate the credential (and PGP-encrypt your files, if you chose that option) in your HR system or ask your IT team to generate it for you. Then click Continue.
Use the Username shown on this screen, together with the credential you generated in Step 3, to authenticate the transfer. If you chose PGP encryption, we will also display a PGP public key on this screen. Copy it. Your HR system must encrypt each file with this key before uploading.
Then, under Destination, send the file(s) to the SFTP server using Address, Port and Directory.
Your HR system must upload the following file(s) to the SFTP server on each run. We support .csv, .json, and .xlsx as file formats. Append the matching extension to each file name (e.g., employees.csv for CSV). The file names must stay consistent over time. Do not include any changing information, such as date or time.
Finally, click Set up integration. Your SFTP credentials will be added to the SFTP server (provided you used a known credential type), and your HR system can start sending data.
Configure your HR system to upload the files to the SFTP server on a recurring schedule (e.g., daily). Most enterprise HR systems support scheduled or recurring exports out of the box. Agree the cadence (daily, weekly, hourly) with the team you are integrating with. Once your scheduled upload runs for the first time, we will receive the files and the integration will start syncing automatically.

File mapping

After the connection is set up and the first file is transferred, a one-time mapping will occur.
Please note that because this one-time mapping process happens manually in the background, the connection will go through a quality assurance process before going live.
No action is required from your side, and you will be notified if any additional input is required from you.
Once the one-time mapping is complete, your data will start syncing automatically

Troubleshooting

My public key was rejected.
Make sure it starts with ssh-rsa and that you pasted the public key, not the private key. If you pasted the private key by mistake, treat it as compromised and regenerate the key pair before continuing.
My PEM certificate was rejected.
Make sure it starts with -----BEGIN CERTIFICATE----- and ends with -----END CERTIFICATE-----, and that the body is preserved intact.
The file was uploaded but it says it was not received.
Double-check the host, port (22), and directory (/) in your HR system's SFTP configuration. Confirm the file name matches exactly (employees.csv, not Employees.csv or employees_2026.csv).
Data is not appearing in the destination application.
The first few uploads may fail until our support team has completed the data mapping. If the problem persists for more than a few days, please reach out to our support team.