Skip to content
Blackbird docs

SFTP

View on Github

SFTP, or Secure File Transfer Protocol, is a secure file transfer protocol that uses secure shell encryption to provide a high level of security for sending and receiving file transfers. To use SFTP, you need to have an SFTP server, where files can be uploaded, stored, and retrieved in a downloadable format. An SFTP server is the type of storage location where files are stored and retrieved.

Before setting up

Before you can connect you need to make sure that:

  • You have a SFTP server and you have the credentials to access it.

Connecting

  1. Navigate to Apps, and identify the SFTP app. You can use search to find it.
  2. Click Add Connection.
  3. Name your connection for future reference e.g. ‘SFTP connection’.
  4. Fill in the Host of your SFTP server.
  5. Fill in the Port of your SFTP server (usually it’s 22).
  6. Fill in the Username of user who has access to SFTP server.
  7. Fill in the Password of user who has access to SFTP server.
  8. Click Connect.

connection

Actions

  • Download file Download file from server by path.
  • Upload file Upload files to server by specified path.
  • Delete file Delete a file from server by specified path.
  • Create directory Create new directory by specified path.
  • Delete directory Delete directory from server by specified path.
  • List directory files List files (name and full path) by specified path
  • Rename file Rename a file by specified path from old to new

Events

  • On files created or updated This polling event triggers when file is created or updated on server.
  • On files deleted This polling event triggers when file is deleted from server.

Example

Here is an example of how you can use the SFTP app in a workflow:

example

In this example, the workflow starts with the On files created or updated event, which triggers when any file is added or updated on SFTP server. Then, the workflow uses the Download file action to download the file that was added/updated. In the next step we translate the file via DeepL and then upload the translated file to Slack channel.

Eggs

Check downloadable workflow prototypes featuring this app that you can import to your Nests here.

Feedback

Do you want to use this app or do you have feedback on our implementation? Reach out to us using the established channels or create an issue.