Requests Feed - SFTP
SFTP Request Feed – Training Guide for Clients
This guide explains how to submit carpooling ride requests to Gett via SFTP.
Connection and Setup
Gett provides your company with access to a dedicated folder on their SFTP server. Authorization requires the following:
- Hostname and username
- Private SSH key
- Whitelisted IP-address
To set up an SFTP folder for your company, You'll need the following information:
- Public SSH Key (use the SSH-2 RSA algorithm). You could use the following guide to generate it.
- List of IP addresses to whitelist (we recommend adding as few addresses as possible and refraining from adding subnets for security reasons)
- An email address to receive a summary of errors during sync
Once we receive this information, we will provide you with the hostname and username when the SFTP folder is set up.
Files management
- A CSV file containing reference data will be deposited in the folder for each reference field and automatically updated from your source at a convenient frequency.
- Once uploaded, the file will be processed within an hour and immediately removed from the folder.
File Format
- File type: CSV (comma-separated)
- Encoding: UTF-8
- Filename:
ride_requests.csv
- Upload method: SFTP
- Pickup method: Gett automatically detects and processes the file once uploaded
Structure
Each row in the file represents one ride request. The table below outlines all required columns:
Column | Description | Format / Example |
---|---|---|
external_id | Unique request ID used for tracking and updates | 12345 |
passenger_name | Full name of the passenger | John Doe |
passenger_phone | Mobile phone number | +972504225101 |
request_date | Date of the ride | 17.07.2025 |
request_time | Time of arrival or departure (24h format) | 08:00 |
direction | Indicates direction of the ride | to work / to home |
work_address | Destination address (if to work) | "Tel Aviv, Ibn Gabirol 24" |
passenger_address | Departure address (if to work) | "Holon, HaHistadrut 11" |
Important Notes
- external_id, request_date, request_time and direction is mandatory for all actions.
- Phone number Must start with the country code in the international format e.g. +44, +972, +7, +1 (We accept the phone number with or without a plus sign)
- The date and time provided must be in the future; past requests will not be processed.
- If the same
external_id
is used again with updated details, the request will be updated. - If a request no longer appears in the file and hasn't yet been confirmed or optimized, it will be deleted.
- Requests that are already optimized or booked will not be deleted or changed.
- Requests created via SFTP can also be edited manually.
Errors & Logging
Gett will validate each file and send two types of email alerts:
- If the file is not processed at all (e.g., due to format issues or missing columns).
- If specific rows failed.
- An error will also be triggered if a file is valid but empty (i.e., no ride rows).
An error processed for a specific user does not impact other users in the file.
For more technical details, contact your Gett account manager.
Updated about 13 hours ago