How do I synchronize my employee data with my HR system?


The employees can be provisioned via a CSV file that gets pushed via SFTP to the Honestly server. Based on the CSV file new employees will be added, not existing employees will be removed and information of already existing employees will be updated. This option is available to Enterprise or Global Player Customers.

Honestly Server

Hostname: ``

Port: `22`

Directory: `~/upload/`


Authentication works via passwordless authentication (ssh key authentication). That way the related public key can be shared with Honestly over an unsecured channel like email. 

The public key should be in ssh-rsa format.

Example public key file 

In SAP SuccessFactors the integration module can be used to send the file. Follow this guide to generate the authentication key.

A rsa public key needs to be shared with Honestly to the email address

A username will be provided by Honestly that can then be used in combination with the private key of the public key to push the CSV file to the Honestly server.

CSV file

The file name needs to be `employees.csv`.

The file needs to be encoded with UTF-8 character set without any BOM.

The data in the file itself needs to be separated by the comma character and surrounded by double-quotes.

The column names need to be included in the CSV file in the first line. The order of the column names is irrelevant. Column headers are case sensitive.

Required columns

The following columns need to be present in the CSV file and also all dataset must contain values for them. 


Column Name
ImportId String The unique identifier of an employee will be used to identify employees that have left the company. Furthermore, the identifier will match existing employee data with the data in the file even when the email address has changed.


String The E-Mail Address of the employee.
Firstname String The first name of the employee.
Lastname String The surname of the employee.


The ImportID of an employee cannot be adjusted over the Upload file.

Optional language

It's recommended to also provide the language of the employee. If the language can not be provided we can configure a default language.

Language ISO 639-1 The primary language of the employee that will be used to select the questions and notification language of the employee. See here for more details.

Optional additional employee groups

Based on the configuration of employee groups in the web application, additional employee data can be included to receive more detailed insights. Therefore the CSV file needs to be extended with these additional columns in String data format.

On the web application the user can select which employee data should actually show up as a filter on the dashboard.

Optional role & permission related columns

Employees have access to results based on their reports to relationship in addition to the permission on specific employee groups. ReportsToId or PermissionGroup and PermissionGroupValue can be blank.

Column Name
Role String

Value needs to be based on the table "Available roles". If no role is assigned (blank field) the employee will only be able to take part in surveys but will not be able to e.g. login to see results or create surveys.

ReportsToId String Contains the ID (ImportId) of the employee that this employee reports to.
PermissionGroup String Contains the name of the column header which drives the employee's permission. e.g. Country.
PermissionGroupValue String

Contains the specific employee group the user has access to e.g. Germany

use `*` to give access to all users

Possible roles

Admin Can do everything and has access to all account data, including all dashboards. Permission groups are not taken care of.
Manager Can manage surveys & dashboards associated with the user groups specified in the permission groups and hierarchy.
Analyst Has read-only access to specific dashboards associated with the user groups specified in the permission groups and hierarchy.
Report viewer Has read-only access to specific dashboards associated with the user groups specified in the permission groups and hierarchy. Can not export any data.


Example file with a department and location employee group

Name: employees.csv


"3","","Lucas","Jansen","nl","Customer Success","Germany","1","Manager","Location","Germany"

Import mechanism

This file is imported twice a day (around 2-4.a.m and 2-4 p.m.).  After a successful import, the import file is removed from the folder. 

Warning: If you choose the automatic upload, any changes made manually will be overwritten every 12 hours.

If there is no file, no changes will be made.