Connections

This article is a work in progress.

Overview

Connections link VRPlatform to external services like booking channels (Airbnb, VRBO), property management systems, and payment gateways. They enable automatic data synchronization.

Key Concepts

Connection Types

Type	Description
`bookingChannel`	OTAs like Airbnb, VRBO, Booking.com
`propertyManagementSystem`	PMS platforms
`paymentGateway`	Payment processors (Stripe, etc.)
`accountingPlatform`	Accounting software integrations
`service`	Other service integrations

Connection Status

Status	Description
`active`	Connection is operational
`inactive`	Connection is disabled

Sync Status

Track synchronization state:

Status	Description
`queued`	Sync is pending
`started`	Sync in progress
`completed`	Sync finished successfully
`failed`	Sync encountered errors
`canceled`	Sync was canceled

Error States

Connections can enter error states when:

Credentials expire or become invalid
API limits are reached
External service is unavailable

API Endpoints

GET /connections - List connections
GET /connections/{id} - Get connection details
POST /connections/{id}/sync - Trigger a sync
GET /syncs - List sync history

Examples

Connection Response

{
  "id": "conn-123",
  "type": "bookingChannel",
  "name": "Airbnb",
  "status": "active",
  "lastSyncAt": "2024-06-15T10:30:00Z",
  "syncStatus": "completed",
  "isErrorState": false
}

Triggering a Sync

POST /connections/conn-123/sync

Response:
{
  "syncId": "sync-456",
  "status": "queued"
}

Reservations - Synced booking data
Listings - Connected properties
Locking - Sync blocked by closed period

Connections

On this page