SFTP Receive Endpoint Settings

SFTP receive endpoint settings determine where to receive messages in the following contexts:

  • Receive from partners

    Source endpoint in an inbound message flow that receives B2B EDI messages from partners either directly or via 3rd party connections

  • Source at host

    Source endpoint in an outbound message flow that receives application JSON and XML messages from the backend systems

A host, partner, or 3rd party connection can own FTP send endpoints.

Create SFTP receive endpoints by configuring these settings on the host or Partner page:

Name Description Required

Endpoint Name

Automatically generated name used to identify the endpoint, which you can subsequently modify manually.



Partner or host that owns the endpoint.



Protocol selected in the Protocol field of the New endpoint. The value in this field cannot be modified.



User-supplied value that describes the purpose of the endpoint.



SFTP server host, such as sftp.mulesoft.com, localhost, or The host must be accessible from your Mule environment.



Port number of the SFTP server.



Username for the SFTP server.

Yes, if the server is authenticated.


Password for the SFTP server.

Yes, if the server is authenticated.

Source path

Path on the SFTP server to which your trading partner sends the inbound files.


Polling Frequency

Frequency in which the server checks the source path for new files. The value in this field is 1 minute by default.


Size check wait time

Wait time, in seconds, between size checks to determine if a file is ready for processing. The value in this field is 1 second by default. This allows a file write to complete before processing.

Mule performs two size checks by waiting the amount of time specified in the Size check wait time field. If both checks return the same value, the file is ready to process.

To disable this feature, specify a negative number or omit the value.


Archival Path

Specify an SFTP server path at which to store a copy of the file that was obtained from source path.


Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub