Introduction

Opening any connection reveals its structured details in the Connection Editor.

The editor consists of two main areas: the menu on the left represents an overview of the different configuration items that can be defined, while the right side shows the detailed view for each item, where the detailed configuration can be performed.

Basic Configuration

The first page shown is the General Configuration tab. Here you define the connection name and optionally provide a description to help others understand the purpose of the connection.

Client Configuration

The Client Configuration tab defines how Connect communicates with an external service. Specifically here is configured how Connect act as a client executing outbound calls to an external (REST) API. You can configure the base URI of your API and can add query parameters, headers, authentication settings, proxy options, and other details.

Server Configuration

Since Connect not only communicates one way but may also need to respond to a request (reacting on inbound calls), the Server Definition tab allows you to configure the way Connect responds.

Here you can define default response headers and review the currently available webhook endpoints in your system

Method Definition

Methods define the operations you perform against an API which is called by Connect as a (REST) client. They are equivalent to OpenAPI path and operation definitions. Here you specify the structure of the request and expected response, along with additional request configuration options.

The method editor interface is split into two main areas. The upper section is where you configure the operation itself: select the HTTP method (GET, POST, PUT, …), enter the resource path, and define parameters, headers, query parameters and validation rules.

The lower section is designed for testing. It shows the composed request with its URL, content, and headers, and displays the response once a test call has been executed.

Event Definition

Defining events follows the same principles as methods, but in the opposite direction. Events describe how Connect should behave when other systems initiate communication with it.

Typically, this is where you configure webhook endpoints and define handlers that replicate or synchronize data into other systems.

Anyhow, technically there are no strict limits - Connect’s modular design allows you to simulate systems, build proxies, or to implement web services.