SFTP Integration

Important Note: SFTP Integration is for Channels only.

Integrate Your Service with Optimove Via SFTP

This document provides instructions for integrating with Optimove via SFTP.

Step 1: Inform Optimove of the channel you would like to use for the SFTP integration.

You can also ask your CSM to rename this channel.

Step 2: Configure your SFTP with your CSM.

Connection Details

Optimove provides each tenant with a dedicated SFTP endpoint.

• Hostname: sftp-{tenantbinding}.optimove.net — a CNAME pointing to Optimove's SFTP load balancer IP. Your Customer Success Manager (CSM) will provide the exact hostname for your tenant. Because the DNS resolves to a CNAME on the load balancer, Optimove can migrate you between servers with zero hostname change on your side.
• Port: 22 (SFTP over SSH).
• Host key fingerprint: Provided by your Optimove CSM at onboarding (and on rotation). Verify (pin) the host key fingerprint on first connect — do not accept it blindly.
• Server IPs: If you need the server IP for firewall whitelisting, contact your CSM, CE, or PM.

Authentication

Optimove supports two authentication methods.

• Username + password: Credentials are issued by Optimove. No client action is required as part of this migration; existing usernames and passwords are preserved as-is on the new server.
• SSH public key: Clients authenticate using an SSH key issued by Optimove.
  • New key algorithm: ssh-ed25519 — the current security best practice for SSH authentication (modern, compact, strong).
  • RSA keys are deprecated. Users still authenticating with an RSA key will be reissued an ssh-ed25519 keypair and contacted directly by Optimove.
  • Store the private key securely and never commit it to source control.

Approved Cryptographic Algorithms

Clients must support at least one option from each category below. Connections that negotiate deprecated algorithms (CBC-mode ciphers, MD5, SHA1-based MACs) will no longer be accepted.

Key Exchange (KEX)

• mlkem768x25519-sha256 (post-quantum resilient)
• curve25519-sha256
• ecdh-sha2-nistp256 / ecdh-sha2-nistp384 / ecdh-sha2-nistp521
• diffie-hellman-group14-sha256
• diffie-hellman-group-exchange-sha256

Encryption Ciphers

• [email protected] / [email protected] (preferred)
• [email protected] (preferred)
• aes128-ctr / aes192-ctr / aes256-ctr

Message Authentication Codes (MACs)

• [email protected]
• hmac-sha2-256

SFTP User IP Restriction Policy

Each SFTP user account can optionally be locked to a list of source IPs or CIDR ranges.

• To enable, request it from your CSM with (a) the SFTP username and (b) the list of allowed IPs/CIDRs.
• Updates take effect within one business day.
• Removing the restriction follows the same process.

Validating Your Client

You can verify that your SFTP client negotiates approved algorithms:

sftp -vvv <user>@sftp-{tenantbinding}.optimove.net

The verbose output should show the negotiated KEX, cipher, and MAC values matching the approved list above. If you see deprecated algorithms in the negotiation, update your SFTP client or its configuration (for example, OpenSSH ~/.ssh/config, the WinSCP cipher list, or FileZilla site settings) before going live.

Migration Notice

To migrate safely:

1. Receive the new hostname from Optimove.
2. Test connectivity end-to-end on the new server, using a non-production file or test folder.
3. Confirm success with Optimove — we then flip the per-tenant DNS to the new server.
4. Resume production uploads only after the flip.

Rollback

If issues are detected after the DNS flip, Optimove can immediately flip the per-tenant DNS back to SFTPGo v2.2.2 with zero client-side change.

Step 3: Synchronize the template list with Optimove.

In order for the templates available in your system to be selectable by marketers when scheduling campaigns within the Optimove UI, the list of available templates must be synchronized between your service and Optimove via API. In other words, your service will provide the Optimove API with the key-value pairs that point to the content in your system (for example, the HTML template for emails or the text content of SMS messages).

• AddChannelTemplates – Provides Optimove with the names and IDs of templates that will be available for selection by marketers when scheduling a campaign to be executed by your service
• DeleteChannelTemplates – Removes previously-added templates
• GetChannelTemplates– Retrieves an array of all defined template IDs and associated names

Once templates are added to Optimove, marketers can select them in Optimove’s Campaign Builder when setting up a campaign that will be executed via your service:

Important note: Your system should call the appropriate API function(s) every time that a new template is added, a template is deleted or a template’s name has been changed. This will ensure that the list available to marketers within Optimove is always accurate and up to date.

Step 4: Optimove will upload the SFTP files.

As soon as Optimove has completed preparing each new campaign, it will upload two SFTP files to your system.

Step 5: Retrieve Campaign Execution Details from the SFTP files.

• 1st File – Campaign Metadata Information that includes Execution date, Channel, Action ID, Action name, Test Action Target Group, Template ID, Template Name, and Schedule Time.
• 2nd File – List of Customer IDs with the Customer Attributes you define. The list of customer attributes will populate every SFTP channel.

Please Note

• The Naming Convention of the files is as follows:
• PlanID_TenantName_TargetGroupName_ActionName_ChannelName_Date.csv

Step 6: Update Response Metrics

Following the execution of a campaign, your system should push campaign delivery and response metrics to Optimove using the UpdateCampaignMetrics and UpdateCampaignInteractions API calls.

In order to ensure this data is displayed properly within the Optimove’s Campaign Analysis and Customer Explorer reports, it is important to call UpdateCampaignMetrics and UpdateCampaignInteractions several times a day for seven days following the execution of each campaign.

Important Notes:

• Customer Attributes are according to the Real Field Name and can’t be modified.
• PlanID is the unique Campaign ID Optimove generates per each campaign.
• It is not possible to change the naming convention of the files.
• Metadata files cannot include additional information such as Tags and Notes.
• The format of the scheduled time is MM/DD/YYYY. Ex: 10/12/2023 1:20:32 PM (W. Europe Standard Time).
• The type of the files is CSV. It is not possible to change it.