Overview

Secure File Transfer Protocol (SFTP) is a network protocol for securely accessing, transferring, and managing large files and sensitive data over any reliable data stream. Designed by the Internet Engineering Task Force as an extension of Secure Shell (SSH) version 2.0, SFTP provides secure file transfer capabilities.

How Does MoEngage Work with SFTP?

MoEngage allows customers to automatically import users and events from their SFTP servers and export events from MoEngage through flat files.

Integration with SFTP servers allows MoEngage to:

• Share periodic exports of campaign interaction events in JSON format.
• Support for Username + Password and Username + SSH Key auth.
• Support for hosts Virtual Private Cloud (VPC) or private endpoints. 

You can export all user and campaign events created, received, or generated by MoEngage to your SFTP servers. By performing this, you can analyze the exported data to gather insights into user behavior, preferences, and other related issues.

Integration

Configure a New SFTP Connection

To import or export data to SFTP servers, you must configure a connection between MoEngage and your SFTP server.

To create a new SFTP connection, perform the following steps:

1. On the left navigation menu on the MoEngage dashboard, click App marketplace. 
2. On the App marketplace page, in the search bar, type SFTP.
3. Click the SFTP tile. The SFTP page appears.
4. Go to the Integrate tab, and then click + Add connection.
5. In the Connection details section, enter the following details:
   
   

   Field	Description	Example
   Connection Name	Specifies the identifiable name of the connection.	SFTP Connection
   Host	Enter the hostname that you want to connect.	128.0.0.0 or ftp.moengage.com
   Port	Enter or select the port to which you want to connect your SFTP server.	Valid ports range from 1 to 65535. The default port is 22.
   Username	Enter the username for the SFTP connection. You can enter an existing user with the read and write access or create a new one for MoEngage.	John Doe
   Authentication Method	MoEngage can connect to your SFTP server using two methods:  Password: Enter the password of the SFTP user (username) in the Password box. Key: MoEngage can connect to your SFTP server using the key pair authentication method. To use this method, perform the following steps: Select Key as your Authentication method. Click the Generate Key icon , and MoEngage displays your public key. You must add this public key to your SFTP server. For more information, refer to How to add a new SSH key to a cloud server (unverified public article). After adding this key to your SFTP user, click Test connect, and MoEngage attempts to verify the credentials. MoEngage also supports the rotation of keys. If your IT policy requires to rotate the keys, you can do it by performing the following steps: Go to the App marketplace > SFTP > Integrate and edit the connection. Click the Generate new key icon . The Generate a new key pop-up window will appear, prompting you to review the instructions. Note: Read the instructions carefully. After you save the connection with the newly generated key, MoEngage will no longer use the previous key. You must ensure that the new key is added to your SFTP server so the rotation works properly. If the new key is not added after saving the connection, your imports and exports might break. Click Generate new key. After the key is generated successfully, a confirmation message is displayed. MoEngage highly recommends that you copy this new key using the icon and attach it as an additional key to your SFTP server. You can also download the key using the  icon. After you have attached the new key, you must test the connection successfully to complete the rotation.  Click Test Connect to generate the new key. If you do not click Test Connect, your old (existing) key will continue to be used as before, and the newly generated key will be deleted from our system.

   Upon clicking Test Connect, MoEngage attempts to verify the credentials and test your details. You can also directly click Connect to proceed.

After the connection between MoEngage and your SFTP server is successful, you can use it to configure various imports and exports in MoEngage.

Set Up Imports from SFTP

MoEngage allows customers to import users and events through files stored inside your SFTP folders. For more information, refer to SFTP Imports.

Set Up Exports to SFTP

To enable SFTP Exports on the MoEngage App Marketplace:

1. On your MoEngage Dashboard, go to the App Marketplace.
2. Search for "SFTP".
3. Go to the Integrate tab and click + Add export.
4. Enter the export details:
   
   

   Field	Description	Example
   Export name	Give the export a name.	SFTP Export
   SFTP connection	Select an existing SFTP connection from the list of connections you created in Set Up a New SFTP Connection.	SFTP Connection
   Folder path	The folder path to which we will dump the files. You can see the preview of file path.
   User properties	Select user properties (user properties and device properties) you want to export with your events. User attributes (such as user attributes, device attributes, and custom attributes) are available in Data Management for that Database/App.
   Select events	Select the events you want to export to your SFTP server. The available options are: All events Select events manually You can choose to export "All events" (existing and new events coming into MoEngage in the future) or cherry-pick events manually and export only those events.
   Select events (drop-down)	This drop-down list is visible only if you select Select events manually under Select events. The events on this drop-down list are auto-populated with all the events in Data Management for that Workspace.
   Frequency	Select how often you want to export these events. We offer three frequencies: Every 15 mins: We will dump files at 15-minute intervals. Daily: We will dump files at the end of each day, 00:00 UTC. Weekly: We will dump files on every Monday, 00:00 UTC. A preview of next dump is displayed in case of Daily and Weekly. It is not recommended to frequently change your export frequency because this might result in data loss or data duplication.

5. Click Save export. Your export will be saved and when the Export status toggle is turned on, MoEngage will start exporting files to the specified folder path on your SFTP server based on the selected export frequency.

Events and Attributes

With the MoEngage and SFTP integration, you can export all events coming into MoEngage to your SFTP servers. By default, MoEngage tracks some standard events and user properties through its SDKs. You can read about our standard events and attributes here. You can also export any custom user-defined event you tracked in MoEngage.

Data Export Format

You can download a sample file from here. This is a GZIPPED file and you must extract it before you can view the files. 

For the full list of events and attributes exported, refer to the Data Exports Glossary.