Node reference

SFTP Download for Joomla and WordPress

SFTP Download is a Step (action) in Connectors › SFTP. Downloads a file from a remote SFTP server into your flow.

Overview

SFTP Download is a Step (action) in Connectors › SFTP. Downloads a file from a remote SFTP server into your flow.

When the flow reaches this step, JOrchestrator executes SFTP Download against your linked site or an external integration, using the field values you set on General and Design. Downstream steps can read the output payload fields defined for this node.

Why use this node

SFTP Download is a action step in the Connectors › SFTP group. Action steps run in the middle or end of a flow. They perform work on your CMS, call external services, or transform data for the next step.

Typical reasons teams add SFTP Download to a flow:

  • Automate "SFTP Download" as part of a larger Joomla or WordPress workflow
  • Replace manual sftp work with a repeatable, logged flow step
  • Chain with triggers, logic, and messaging nodes on the same canvas

Example workflows

Common patterns on the canvas:

  1. Trigger or Webhook → upstream steps → SFTP DownloadSend Email or CMS update
  2. Scheduled triggerSFTP DownloadDebug (while testing) → production action

How to set it up

Enter host, credentials, and remote path on the Design tab.

Good to know

Body encoding can be auto, text, or base64.

Properties panel

The designer shows these tabs for this node:

TabPurpose
InfoPlain-language description and output payload fields for downstream steps
GeneralCanvas label and read-only node ID
AIOptional assistant to help draft settings from plain language
DesignNode-specific configuration fields

System (automatic — not edited by the user)

These fields are managed by the designer or runtime — you do not type into them directly:

Property keyLabelTypeRequiredVisible whenNotes
_nodeIdNode IDnode-idNo
_payloadFieldsAvailable Fieldspayload-panelNo

User-configured — General tab

Property keyLabelTypeRequiredVisible whenNotes
labelLabeltextNoNode label

User-configured — Design tab

Property keyLabelTypeRequiredVisible whenNotes
timeoutSecondsTimeout (seconds)number (default: 30)No
remotePathRemote pathpayload-textYes/path/to/file.txt
bodyEncodingResponse body encodingselect (auto | text | base64; default: auto)No

CMS-backed (options from the linked site)

Property keyLabelTypeRequiredVisible whenNotes
sftpSiteIdSFTP sitesftp-site-selectYesRequired. Choose a site preset saved under Node Configuration → Nodes → SFTP in Joomla or WordPress.

CMS site configuration (not on this node's properties panel)

Credentials, API keys, mailers, SMTP, and integration defaults are configured in the CMS plugin under Node Configuration, not per step on this node. Link the flow to a domain before testing CMS-backed fields.

Output payload fields

After this step runs, later nodes can reference these fields using placeholders such as {{sftp_download.success}}.

Field keyTypeDescription
successbooleanWhether the operation completed successfully.
hoststringText value from this node's output.
remotePathstringText value from this node's output.
bodystringDownloaded file content as text or base64.
bodyEncodingstringtext or base64 — how body is encoded.
byteLengthnumberSize of retrieved content in bytes.
messagestringHuman-readable status, error, or result summary.

Validation rules

  • Remote path (remotePath) must be filled before the flow can be saved.