Cloud Sync Overview
Real-time collaboration with WebSocket sync, infrastructure nexus for shared servers, version conflict detection, todo sync, and a public cluster ecosystem.
Real-Time Sync
VortexHQ uses Laravel Reverb (WebSockets) for real-time, bi-directional sync. When you edit a request, teammates see the change instantly.
The sync status indicator shows:
- Live — Connected and syncing in real-time
- Syncing — Push/pull in progress
- Synced — All changes saved
- Offline — WebSocket disconnected; changes queued
Conflict Resolution
VortexHQ uses JSON Patch (RFC 6902) for partial updates — supporting add, replace, and remove operations. If two people edit different fields, both changes merge automatically. If the same field is edited, a version-based conflict detection system (HTTP 409) triggers and the latest write wins with a notification banner.
Infrastructure Nexus
Beyond API cluster nexuses, VortexHQ supports Infrastructure Nexuses — shared workspaces for servers and database connections:
- Shared SSH hosts — Add SSH servers to the nexus; team members see them in the SSH and FTP modules
- Shared FTP hosts — Share FTP/SFTP connections across the team
- Shared SQL connections — Share database connections; available as SSH tunnel sources in the SQL client
- Vault encryption — Server credentials are encrypted end-to-end with a nexus vault key. Vault-locked servers show a lock icon and require decryption before use.
- Vault key sync — Vault keys are synced securely between nexus members
Create an Infrastructure Nexus from the workspace selector, invite team members, and all shared servers sync in real-time.
Todo / Task Sync
Tasks created in the Task Manager can be synced to the cloud:
- Full CRUD sync — create, update, delete, and reorder tasks across devices
- Real-time sync via WebSocket (
TodoSyncedevent) - Clear done tasks syncs to all devices
- Reorder operations sync the full sort order
Heartbeat
VortexHQ sends a lightweight heartbeat to the server at regular intervals to signal the user is active. This powers presence indicators and helps the server track active sessions.
Real-Time Events
Each Nexus channel broadcasts these events:
- ClusterUpdated — A cluster was modified
- ClusterCreated / ClusterDeleted — Cluster lifecycle
- MemberJoined — A new team member accepted an invite
- ClusterForked — Someone forked a public cluster
- ChangeRequestCreated / Approved / Rejected — Change request lifecycle
- InviteReceived — Sent to the invited user's personal channel
- TodoSynced — Task list changes pushed to other devices
- ServerCreated / ServerUpdated / ServerDeleted — Infrastructure server changes
Authentication
Cloud sync requires an account. Sign up with:
- Email + password (with email verification)
- Google OAuth
- GitHub OAuth
Auth tokens are stored in your system keychain via Electron safeStorage (macOS Keychain, Windows DPAPI). No plaintext token fallback.
Per-User Data Isolation
When you sign in, all local data (emails, SSH hosts, FTP hosts, SQL connections, API clusters, snippets, AI config) is migrated to a user-specific directory. Signing out clears the active user data and restores defaults.
Cluster Sharing
Each cluster has a visibility setting:
| Visibility | Who Can Access |
|---|---|
| Private | Only you and Nexus members |
| Public | Discoverable in Explore. Anyone can view, star, subscribe, and fork. |
Explore Public Clusters
Browse the Explore tab to discover public API clusters shared by the community. Sort by stars, search by keyword, and paginate through results. Star your favorites, subscribe for update notifications, or fork them into your own workspace.
Change Requests
Like pull requests for code, Change Requests let you propose edits to a shared cluster:
- Create a change request with a title, description, patches, and modified payload
- Team members review and add comments
- Approve (with merge option that auto-applies the patches) or reject
Nexus Members
A Nexus is a shared workspace. Invite team members by email or search by name:
- Assign roles (default: editor)
- Accept/reject invitations
- Remove or update member roles
- Cancel pending invitations