FTP servers

The platform can write an XML document to your own sFTP server every time a significant event happens — an order is created, an order item is refunded. This is the file-based alternative to webhooks, and it is useful when your back office ingests files rather than HTTP callbacks.

Visible to Admins only.

Columns

Column	What it shows
#	Row number in the current view.
sFTP IP	Host or IP address of the server.
Comments	Your own note about what this server is for.
Status	Active or Inactive. Files are only delivered to active servers.
Test column	Result of the most recent connection test.

Add a server

1. Click Create.
2. Fill in the form.

Field	Required	Notes
sFTP IP	Yes	Host name or IP address, for example 192.168.1.1 or sftp.example.com.
Port	Yes	Defaults to 22.
sFTP folder	Yes	Absolute path to the destination directory, for example /uploads/data. It must already exist and be writable.
Username	Yes	The sFTP account.
Password	Yes	The sFTP account password.
Comments	No	Free text, for your own reference.
Status	Yes	Active by default.

3. Click Check connection to test the settings before saving.
4. Click Create.

note

Your browser may autofill Username and Password with your portal credentials. Clear both fields and enter the sFTP account details before testing.

Check connection

Check connection opens an sFTP session with the settings entered and uploads a small test file to the target folder, so a successful result proves both authentication and write permission.

<note>
    <heading>This is a test file</heading>
    <body>This is a test XML file to check server connection.</body>
</note>

Delete the test file from your server afterwards if it would otherwise be picked up by your import process.

Edit a server

Click a row to open it, change what you need, re-test the connection, and save.

If you navigate away with unsaved edits, the portal asks before discarding them.

Click Keep editing to return to the form, or Discard changes to leave.

What gets delivered

An XML document per event — order created, order item refunded. The document schema is documented in XML description.