JSON reference

Configuration reference

The application accepts a versioned UTF-8 JSON document delivered over HTTPS.

Complete example

{
  "schemaVersion": 1,
  "identity": {
    "configurationName": "Example Customer Support",
    "configurationId": "example-customer"
  },
  "branding": {
    "applicationName": "Support Details",
    "companyName": "Your IT Support Provider",
    "providerTagline": "Here to help when you need us.",
    "trayIconUrl": "https://example.com/tray.ico",
    "logoUrl": "https://example.com/logo.png"
  },
  "support": {
    "telephone": "01234 567890",
    "email": "support@example.com",
    "website": "https://www.example.com/",
    "supportText": "Please contact the support team if you need assistance.",
    "messageOfTheDay": "Please have your computer name ready."
  },
  "tray": {
    "primaryLinks": [
      { "label": "Open remote support", "url": "https://support.example.com/" }
    ]
  },
  "externalIp": {
    "enabled": true,
    "url": "https://api.ipify.org"
  },
  "refreshIntervalMinutes": 60
}

Top-level properties

schemaVersion

Required. The current supported value is 1.

identity

Describes the hosted configuration for diagnostics. It is not authentication.

branding

Window title, provider name, tagline and HTTPS branding assets.

support

Customer-facing telephone, email, website and explanatory text.

tray

Up to three trusted HTTPS links shown in the tray menu.

externalIp

Enables or disables the public IPv4 lookup and selects the HTTPS endpoint.

refreshIntervalMinutes

Periodic safety refresh. Values are constrained to 15–1440 minutes.

Validation and safety

Remote configuration and assets must use HTTPS. Invalid links are ignored. Unknown properties may be ignored for forward compatibility, while an unsupported schema version is rejected.

Optional values

Blank optional contact fields are omitted from the Support Details window. An omitted or blank provider tagline falls back to “Here to help when you need us.”