Check the format and required information
Decide what you're going to upload
For example, every day, you upload 2 files:
...which contains a single CSV file, orders.csv
...every line of which has name, address
...which contains a single CSV file, customers.csv
...every line of which has name, address, email
Extra fee applies
- Multiple CSVs per file
- CSVs without headers
- Tab separated or fixed width
- Joining in identifying information from other files
- Putting 2 CSVs in a single ZIP file
...instead, upload 2 ZIP files with 1 CSV each!
- Uploading an orders file with no identifying information, only an order ID
...instead, put name, address, etc. on every order line before you upload!
- Encrypting before zipping
...instead, zip before encrypt!
Send via Amazon S3 (our bucket)
If you want to upload to a bucket we control, just contact your CSM and they'll get it set up. We will need an AWS username like
arn:aws:iam::$YOUR_AWS_ACCOUNT_ID:user/acme_to_faraday and then we will give it access to a bucket.
When you upload, be sure to set your ACL to
Send via Amazon S3 (your bucket)
Upload your files to a bucket you control.
Then give us access to a folder (in the example below, I use the folder
to_faraday/ in the bucket
acme-faraday-interchange ) by defining a bucket policy:
Then, we have to add the bucket name to the iam user here https://console.aws.amazon.com/iam/home?region=us-east-1#/users/stagecraft-download_s3
Upload with SFTP
First things first, we need your SSH public key. They look like this:
Needless to say, they are NOT secret - that's why they're called "public" keys.
Do not EVER send us (or anybody else) your SSH private key.
If you don't have an SSH keypair, you can generate one like this https://www.digitalocean.com/docs/droplets/how-to/add-ssh-keys/create-with-openssh/. Be sure to store the private key safely - you will need it to connect in the future.
Go ahead and paste your public key into https://app.faraday.io/settings/integrations
Using your favorite SFTP client:
- Port: 22
- Username: varies by client (for example,
- Password: not enabled, you must use an SSH public key as explained above
Let's pretend you work for Acme, Inc. Your SSH private key file is
/path/to/acme_rsa (remember, this is a secret, don't sent it to us) and the username given to you by Faraday is
You will upload files like this:
$ sftp -i /path/to/acme_rsa firstname.lastname@example.org
Connected to email@example.com.
sftp> put helloworld.csv.gz to_faraday/helloworld-2019-01-15.csv.gz
Uploading helloworld.csv.gz to /faraday-acme/to_faraday/helloworld-2019-01-15.csv.gz
A few notes:
- You won't be able to download or even see files once you send them to us - that's a security measure called a "blind dropbox."
- You need to upload it to the
to_faraday/folder as shown above.
- See above for requirements on file format, etc.
- The most secure option is to encrypt your file with GPG (aka PGP) before you send it to us. See https://knowledgebase.faraday.io/help-and-support/optimize/how-to-encrypt-files-with-gpg.