In Synatic, you can use Relays to connect to on-premise legacy systems and move or relay data from the legacy systems and services (such as Files, Databases, or SDKs) to Synatic.

In this article, we'll discuss in detail each setting and option to create a Relay. Each Relay has several settings you can configure to control its operation.

Create a Relay

Selecting a Mode

Adding an Endpoint


Managing the Relay in the Info Tab

Relay System Requirements

When you create a Relay, the New Relay dialog opens.

Relay Name

Enter an identifying and meaningful name for the Relay and a full description.

Select a Mode

At this stage, only the Asynchronous mode is available. This implies that when the Relay operation is triggered, the resultant data is held in a memory cache. You would then process the data in a Synatic flow by either saving it somewhere or importing it into another resource.

Cache Definition (in minutes)

Set the Cache Definition to a period in minutes. This cache holds the Relay settings in memory, set in minutes, while the Relay is running.

Adding an Endpoint

Each Relay requires that you identify and define the location of the source legacy data and capture it into an endpoint.

To add an Endpoint, select the Connector icon in the Connection Type field.

The Select a Connection Type dialog provides access to many different system connectors. For this article, we'll describe the File System connector to get data from a legacy file. You can also create endpoints to any of the other available endpoints, so you would select one suited to your requirement.

To identify the Endpoint, type in a meaningful name and description.


When you are done configuring the Endpoint, click Save to confirm the configuration. The Info Tab opens with further options to configure and test the Relay.


Delete an Endpoint

You use this option to delete the Endpoint you are currently working on by clicking the Delete Endpoint text button.

Add Endpoint

You use this option to connect to additional Endpoints.

Info Tab

When you have created a Relay, the next step is to download the Relay's relevant certificate, configuration file, and the Relay Manager.


The following downloads are available for the Relay you have just created.

Download Relay Certificate.
This option downloads the file RelayCertificate_<ACCOUNT>_<ENDPOINT>.src which contains the certificate.

  • Download Example Config File.
    This option downloads the file <ACCOUNT>_<ENDPOINT>_config_example.json which contains the Relay configuration settings to load into the Relay manager.

  • Download Relay Installer
    This option downloads the file SynaticRelayManagerSetup.msi which is the installer file for the Relay Manager.

  • Download QuickBooks Relay Manager
    This option downloads the file SynaticQBRelaySetup.msi which is the installer file for the QuickBooks Relay Manager.

  • Download Latest Generic Windows Relay
    This option downloads the file which is the source file for the latest Windows Relay.

You can also use the following additional options:

Last Heartbeat

Relays send a Heartbeat every 5 minutes to signal they're still active. This option lets you check when the last heartbeat was sent.

Test Relay

This option executes a test on the Relay to ensure that all connections and endpoint functions are correct.

📝 This test is done in conjunction with a Relay-based Synatic Flow.

Restart Relay

This option executes a restart of the Relay service, which you can install and start in the Relay manager.

Re-Key Relay

This option regenerates the license key of the Relay you created. You must restart the service after this process is complete.


A new version of the Relay can be created whenever you edit or update the Relay.

Relay System Requirements

For Windows

Operating System

  • Windows Server 2012 (64 Bit)

  • Windows Server 2012 (64 Bit) R2

  • Windows Server 2016 (64 Bit)

  • Windows Desktop 10 (64 Bit)


  • 1 GB RAM minimum (>1 GB depending on processing workload)

HDD Space

  • 500MB Minimum


  • Outbound access to

  • Network connectivity to endpoints defined in the configuration.

  • Internet speed will dictate processing throughput.

Useful Tutorials

Revisit the Getting Started page for a refresher.

Read the Relays overview.

Read more about Relays.

Learn more in the Relays Tutorial video.

Did this answer your question?