How to Create and Configure an SFTP Integration Sync

Learn how to set up and customize a new CRM integration within the Offstreet dashboard. This guide walks you through the process, from initial naming to mapping fields and defining customer segments for your permits.

Jodine Landman
10 steps
34 seconds

Offstreet

Customer Integrations

Click on the main Customer Tab from the left hand menu. Once in the customer section Click "Uploads & Syncs"

Click "Add integration" under Automated Sycs to start the SFTP integration sync setup.

Integration Details

Enter "Your Integration Name" in the Integration Name field.

Enter a short Name in the Short Name field, a short identifier to represent this integration. Once completed click "Next" to continue to the next step.

Sample Data Upload

Click "Browse" to select a sample sheet of your data you wish to sync. Select a file you wish to import.

Manage Segments: Segments control which customers are eligible for specific permit types. This integration can automatically add or remove customers from segments each time it syncs. Only the segments managed by this integration will be updated.

**Handling Missing Customers** **Choose what should happen if a customer is not included in a future sync:** - Do nothing – Leave their segments and permits unchanged. - Remove assigned segments – Remove the segments managed by this integration, but keep any existing permits active. - Remove assigned segments and cancel permits – Remove the managed segments and automatically cancel any permits linked to those segments.

**Segment Assignment** Choose how customers should be assigned to segments during the sync: - Assign using custom rules – Assign segments based on one or more customer properties (for example, Department = HR or Employee Type = Staff). - Assign using a spreadsheet column – Assign segments based on the value in a specific column of your spreadsheet (for example, the "Segment" column). - Don't assign segments – The integration will not automatically assign any segments. You will need to manage them manually.

Field Mapping

Ensure you have the properties set up under customers before mapping the data.

On the next step you will map your data accordingly. Map the fields in your file to the fields in Offstreet.

Click "Create integration" and you will receive the information for the SFTP details. Integration Created\ Share these credentials with your source system administrator to complete setup. The integration will become Active after the first successful sync. Click on "Copy Details" to copy the necessary details for the team.