Home Schema Example JSON Schema

Device Metadata

Type: object

Device.metadata is common across providers and will be used by us for differentiating between types of devices.

 No Additional Properties

root platform

Platform

Type: enum (of string)

Used to distinguish between mobile users and desktop users. We don't differentiate between web mobile and web desktop users at this time.

Must be one of:

  • "mobile"
  • "web"

root channel

Channel

Type: enum (of string)

The messaging platform/system.

Must be one of:

  • "native"
  • "sms"
  • "line"
  • "messenger"
  • "telegram"
  • "wechat"
  • "web"
  • "whatsapp"
  • "viber"
  • "email"

root os

Operating system

Type: enum (of string)

The operating system the user is on. Not set when on a non-native messaging platform.

Must be one of:

  • "android"
  • "ios"
  • "windows"
  • "linux"
  • "mac"

root application

Application

Type: enum (of string)

The name of the application accessing the server.

Must be one of:

  • "hospital"
  • "cleo"
  • "einstein"
  • "other"

root version

Application Version

Type: integer

An integer representing the version of the application.

Value must be greater or equal to 1 and lesser or equal to 2

root browser

Browser

Type: enum (of string)

The type of browser the user is on. Only applicable when platform is web.

Must be one of:

  • "safari"
  • "chrome"
  • "msie"
  • "opera"

root is_subscribed

Is Subscribed?

Type: boolean

The subscription status of this device.