Skip to main content

How do I sync employee data with Nectar using SFTP?

Automate your employee data sync to Nectar by using Secure File Transfer Protocol (SFTP). This setup ensures your user data stays current.

Marissa Tingey avatar
Written by Marissa Tingey
Updated today

Note: This setup typically involves your IT team. Please share these technical steps with them. You may also want to involve your HRIS Integration Specialist. Depending on your product plan, setup fees may apply.


Step 1: Create a custom report in your HRIS

Build a report that includes the employee data you want to sync with Nectar. We recommend using our Employee Data File Template to get started.

If your organization already has employee data in Nectar, go to Admin > Users > Download to CSV. You can use the column headers from this export as your template.

At a minimum, your report must include:

  • Name

  • Employee Email (column heading: Email)

You can also include additional fields such as:

  • Preferred Name – Used in surveys (first name only)

  • Manager Email

  • Department

  • Date of Birth

  • Start Date

  • Office Location

Important: Field names must match the template exactly. If your HRIS uses different field names, ensure they’re correctly mapped and renamed in the report. Use this file to compare your field names.

Please Note: You may need to contact your HRIS provider to create a custom report. This could involve additional costs depending on their policies.


Step 2: Generate an SSH key pair

To securely connect your HRIS or SFTP client to Nectar, you'll need to create an SSH key pair.

  • The private key stays with your system or HRIS provider.

  • The public key should be added in Nectar > Admin > Integrations > SFTP Sync > Public Key field (Account Admin access required).

Note: Nectar only supports OpenSSH key pairs. If your system creates SSH2 keys, you’ll need to convert them. See our technical guide for help.


Step 3: Set up the SFTP connection

Your SFTP client will require the following information to connect to Nectar. This can be found in Admin > Integrations > HRIS SFTP Sync in Nectar:

  • Protocol: SFTP

  • Logon Type: Key File

  • Host/Hostname: (copied from Nectar)

  • Username: (copied from Nectar)

Note: Hostname and username are case-sensitive. Make sure you copy them exactly from the setup page in Nectar.


Having trouble with the integration?

If your data isn't syncing correctly, check out our SFTP Integration Troubleshooting Guide for common issues and solutions.

Did this answer your question?