Quickstart

This quickstart takes you from a fresh account to a working, encrypted connection with a partner organization. It links out to detailed pages for each step.

Note

This walks through the Contact System flow. To build the channels themselves on your server, see Mirth Admin.

Before you begin

• You can sign in to the platform.
• You have at least one integration server to register (or you can connect one server to itself to try the flow end to end).
• Your subscription tier allows the servers, contacts, and channels you plan to create. You can complete this whole walkthrough on the Free tier during the open beta.

1. Register a server

Go to Servers and register the integration server you operate. You’ll give it a name and type. Registration produces credentials your server uses to stay in sync with the platform.

→ Details: Servers

2. Find a partner

Open the Directory to find the person or organization you want to work with — during the beta every account is listed. Search by name and open their profile.

→ Details: Directory

3. Send a contact request

From the partner’s Directory entry, send a contact request with a short message. The partner reviews it in their Contacts → Inbox and accepts, which creates an agreement between your organizations.

→ Details: Contacts

4. Connect channels

Click Connect Channels on the Servers page (it’s also on the Channels page and the dashboard checklist). The wizard asks what you want to do — send data to a contact, receive data from one, or connect your own servers — then walks you through picking the partner and the endpoint.

If the server has nothing to share yet, keep the wizard’s default: it creates a managed channel for you — you pick a name and a data type, and the platform builds and deploys the Mirth channel automatically. This is the route to use on the Free tier — the manual Gateway Listener path in the Mirth channel editor is gated to paid tiers.

→ Details: Connect channels, step by step · Managed channels · Grants

5. Provision the connection

When the grant is approved, the platform creates the OpenShare connection that carries the channel data automatically — there’s no separate offer to accept. The tunnel runs over the gateway. The wizard’s Setup progress checklist tracks all of this live, from the partner’s approval through Data link live.

If you also want remote admin console access to a server, go to Console Access and provision a console connection, choosing Read-only or Read-write access. The other party accepts the offer before the tunnel is established.

→ Details: Connections · Connection types

6. Confirm it’s connected

On the Console Access page, watch the connection’s status. A healthy connection shows Active with a live Connected indicator. The first time data flows, the Last connected timestamp updates.

→ Details: Connection status & indicators

You’re connected

That’s the full path: register → connect → grant → provision. From here you can add more channels, more partners, and monitor everything from Fleet Monitoring.

Stuck on a step? See Troubleshooting connections.