Prerequisites
When setting up a connection via SFTP, you will have to share the credentials that you will use when transferring data (i.e. a ssh public key).
You will be provided with the:
- 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 of course in charge of selecting which data is included in the file you transfer.
Selecting which data points are enabled or disabled in this step is therefore often not required, but if modified, it will act as an additional filter for deciding which data is stored for the integration.
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.
- Once the credential type is selected, you will be presented with the remaining data points required to create the integration:
- Use the Username in combination with your generated credentials to authenticate the transfer.
- Send the file to sftp://sftp.kombo.dev, on port 22, to the root directory ("/").
- Use employees.* as the file name. We currently support both JSON and CSV as file formats (name your file employees.json or employees.csv respectively).
- Click Set up integration. Your SFTP credentials will be added to the SFTP server (provided you used a known credential type), and you can start sending data.
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