SFTP Receive Endpoint Settings

SFTP receive endpoints configure where to receive B2B messages transmitted over SFTP. There are two types of SFTP receive endpoints:

  • Receive from Partners

    Source endpoint in an inbound message flow that receives B2B messages from partners either directly or via third-party connections.

    A host, partner, or third-party connection can own SFTP Receive from Partners endpoints.

  • Source at Host

    Source endpoint in an outbound message flow that receives messages from the backend applications.

    Only a host can own SFTP Source at Host 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 that the endpoint supports.



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.

x (if the server is authenticated)


Password for the SFTP server.

x (if the server is authenticated)

Source path

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


Polling Frequency

Frequency at which the server checks the source path for new files. The default value is 1 minute.


Size check wait time

Wait time, in seconds, between size checks to determine if a file is ready for processing. The default value is 1 second. 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.


Supported Format Types

Indicates whether the endpoint supports EDI messages (EDIFACT, X12) or non-EDI messages (JSON, XML).


File name pattern

Filename pattern required by your partner.

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!

View on GitHub