Connection Creation

Use this flow after you know the managed team id. All connection routes use provider API key auth plus x-team-id.

1. Discover The App ID

curl 'https://api.edge.vrplatform.app/apps?search=Hostaway' \
  -H 'x-api-key: <provider-api-key>'

Use the returned id as appId when creating the connection.

Useful response fields:

• id
• name
• type
• category
• description
• flows
• extractors
• importers

2. Create The Connection

curl -X POST 'https://api.edge.vrplatform.app/connections' \
  -H 'x-api-key: <provider-api-key>' \
  -H 'x-team-id: <managed-team-id>' \
  -H 'Content-Type: application/json' \
  -d '{
    "appId": "hostaway",
    "name": "Hostaway Production",
    "credentials": {
      "accountId": "acct_123",
      "apiKey": "secret"
    }
  }'

Body fields:

• appId required
• name optional
• credentials optional

Behavior:

• x-team-id is required
• appId must exist in GET /apps
• if name is omitted, VRPlatform derives a default from the app name
• credentials are mirrored into ingest-owned runtime storage
• property-management-system apps may queue follow-up initialization asynchronously

3. Read Back The Connection

Common follow-up routes:

• GET /connections
• GET /connections/{id}
• POST /connections/{id}/sync

Use the same headers:

x-api-key: <provider-api-key>
x-team-id: <managed-team-id>

Use this to confirm:

• connection id
• status
• sync state
• enabled flows