2.1.1 Beacon object

An iBeacon that references a specific drill, course or test.

Example

{
  "id": "07212ead-8344-4426-8b41-8b0cb621625a_0000_0001",
  "proximity": "FAR",
  "lingerDuration": "PT5M",
  "description": "iBeacon in main hall",
  "playable": {
    "id": "5x7kjFr2vfbptyUTsTximg",
    "type": "DRILL",
    "name": "17th Century Painters",
    "icon": {
      "type": "image/png",
      "url": "https://www.drillster.com/bin/feature/a17ab8d1cb2bd2fee8c60037995a30b42d837353"
    }
  }
}

Fields

Field	Type	Description
`id` required	String	Unique reference (ID) for this beacon. This reference consists of a UUID, followed by an underscore, then the major beacon value (in hex), another underscore and finally the minor beacon value (in hex). The UUID is fixed and is always equal to `07212ead-8344-4426-8b41-8b0cb621625a`. Example value: `07212ead-8344-4426-8b41-8b0cb621625a_0000_0001`
`proximity` required	String	Represents the beacon proximity that should trigger a message. This follows the iBeacon guidelines for beacon proximity. Supported values: `FAR` – approximately 10 meters `NEAR` – a few meters `IMMEDIATE` – a few centimeters
`lingerDuration` required	Duration	A 🔗 ISO 8601 duration during which a beacon should remain visible in a client application after first detection. Example value: `PT5M` (meaning five minutes).
`playable` required	2.1.1 Playable object	The playable object that is associated with this beacon definition. This can be a drill, course or test.
`description` optional	String	An optional description of this beacon. The value is not shared with end users.

Last updated on 2025-04-18