Getting Started with SFTP

Wellhub supports SSH File Transfer Protocol (SFTP) for secure file exchanges. SFTP uses the Secure Shell (SSH) network protocol and public/private key pairs to enforce security.

General Information

Connection settings

  • Host: sftp.clients.wellhub.com
  • Port: 443

Limits

LimitValue
Total number of sessions per client5
Max file size40 Mb
Total number of files per session2
Unprocessed files per session1
Accepted file types.xlsx, .xlsx.pgp, .xlsx.gpg, .csv, .csv.pgp, .csv.gpg

Authentication

To interact with the SFTP Server, you'll need to generate an SSH key on your computer, create an SSH user in the Wellhub Clients Portal, and register your SSH public key.

Generate an SSH Key

  1. Open a Terminal and paste the text below, replacing the email with your email address.
BASH
ssh-keygen -t ed25519 -C "your_email@example.com"
Note

When executing this command, the SSH key generator will ask for information such as where to save the new key and whether or not it should have a passphrase. If you have any doubts during this process, refer to this step-by-step guide from GitHub.

Create an SSH User

With an SSH key in hand, access the Portal using your Wellhub account.

The process for creating a new SSH user is the same, regardless of the type of management of your Wellhub account.

  1. Select which entity you want to manage through the SFTP Server — a single company (Single Entity) or multiple companies (All companies access for Multi Entity; or Channel Partners).
All companies view (Multi Entity / Channel Partners)
  1. In the sidebar menu, click Settings, and in the Automations section, click SFTP.

  1. On the SFTP page, click Create SSH key.

  2. Give a name to this new user and paste the public key of your new SSH key in the appropriate field.

  1. After clicking Create, your new SSH user will be listed on the SFTP page.

Accessing the SFTP Server

Before connecting to the SFTP Server, you need the User name of an SSH user created in the Portal.

  1. Go to the SFTP page (sidebar menu, Settings, then SFTP) in the Portal.

  2. Choose an SSH user and click the right arrow icon.

  3. In the drawer, click Copy or manually copy the User name.

Connect to the SFTP Server

  1. Open a terminal and run the command below, replacing your_username with the User name copied in the previous step.
BASH
sftp -P 443 -i ~/.ssh/id_ed25519 your_username@sftp.clients.wellhub.com

The flag -i ~/.ssh/id_ed25519 indicates the location of your SSH key's private key. Change the location if necessary.

  1. Upon executing this command, you should see the welcome message from the SFTP Server.

File Exchange Frequency

The first production Eligibility File must be sent to Wellhub at least one week before the date that the Wellhub program will be announced to your company's employees.

For maintenance purposes, the Eligibility File must be sent to Wellhub at a minimum once a month. When integrating full files, sending it more than once a day is not recommended.

File Format Requirements

  • It must include the configured eligible identifiers for the client/company tax ID — see Entity Types for details
  • The header is mandatory, and needs to be in English for all countries
  • The column order is not mandatory
  • The column titles (attribute names) must be written exactly as indicated in the specification
  • Unknown columns will be ignored
  • The CSV can use any of the accepted separators: comma (,), semicolon (;), tab, and space
  • CSV UTF-8 is the format supported
  • National ID and Tax ID are validated as a mask; if they are wrong, an error is thrown
  • Accepted file types: .xlsx, .csv → for SSH; .xlsx.pgp, .xlsx.gpg, .csv.pgp, .csv.gpg → if PGP is enabled

Note that even though .csv is supported, since this file format can be mutable, using .xlsx or encrypted files with PGP is highly recommended.

File Naming Convention

For production: your company name_Eligibility_mmddyyyy.csv

For test: your company name_Eligibility_Test_mmddyyyy.csv