Create a Connection

Created by Reachware Support, Modified on Sun, 15 Mar at 4:04 PM by Reachware Support

Understanding the Connection

A Connection in Reachware Studio is a configured System instance that contains client-specific credentials and settings. While a System is a template, a Connection is the actual working link to a specific client's account, including the authorization for each user. Connections allow you to:

Reuse the same System template for multiple clients
Keep credentials secure and organized
Separate production and testing environments

How to Add a Connection

Access Connections

From the Studio section, select the Connections tab, then click Add New Connection in the top-right corner.

Select a System

A list of available Systems will appear. Select the one you need to use.

General Information

Fill in the basic details for this connection.

Field	Requirement	Description
Connection Name	Required	Unique identifier for this connection. See naming format below.
System Name	Auto-filled	Populated automatically based on the selected System.
Description	Optional	Brief details about this specific connection.

Recommended Naming Format

Use the format: Environment | Client Name

Production | Reef
Sandbox | Demo Client

This helps easily identify the environment and client, keeps connections organized, and prevents confusion between test and production.

System Variables

System Variables are required values defined by the System that must be provided for the integration to work. They typically include configuration details such as the domain or authentication credentials, and their values are specific to each client while being stored securely by the platform.

Connection Validation

Before saving, test that your connection works. There are two validation options:

Option 1: Connection Setup

Tests an endpoint without needing a predefined operation.

Relative URI: The endpoint path (e.g., /api/customers)
Method: GET, POST, PUT, DELETE
Operation Inputs: Any required parameters

Use when: Testing a basic endpoint to verify connectivity.

Option 2: Operation Testing

Uses a predefined operation from the System.

Select an existing operation
Fill in the required operation inputs

Use when: You have operations already configured.

Professional Hint

For easier validation, use simple GET operations.

Review Test Results

After running the validation, review the request and response data to verify that the integration is working correctly.

Save the Connection

Review all information, then click Save. The Connection is now ready to use in integration Flows.

Managing Connections

Edit a Connection

Go to the Connections tab
Find your connection and click Edit
Modify the required values (System selection cannot be changed)
Re-validate if credentials have changed
Click Save

Deactivate a Connection

Edit the connection
Change Status to Inactive
Click Save

Inactive connections cannot be used in Flows but are preserved for future use.