Outage Started · HyperTrack Docs

To detect when a worker no longer has location permission to track, watch for his webhook is sent when a worker gets into an outage.

[
  {
    "type": "worker",
    "device_id":"AB930CCD-50A9-4ECA-8758-D7CB09058606",
    "data": {
      "value": "outage_started",
      "outage_category": "behavioural",
      "outage_code": "location_permissions_denied",
      "outage_label": "Location permissions denied",
      "outage_description": "The worker explicitly denied permissions in response to system prompt or in Settings > App Name > Location on iOS. On Android, the worker should change location permission to 'Allow' in App Info > Permissions > Location."
    },
    "recorded_at": "2024-11-28T12:45:00.000Z",
    "location": {
        "type": "Point",
        "coordinates": [
          77.643271,
          12.94964
        ]
    },
    "worker_handle": "ram@123",
    "version": "3.0.0"
  }
]

Name	Type	Mandatory	Description
data.value	string	Yes	`outage_started`
data.outage_category	enum	Yes	adversarial, behavioural, sporadic, os, reachability
data.outage_label	string	Yes	Short human-readable label corresponding to outage_code. Suitable for displaying in dashboards or alerts.
data.outage_code	string	Yes	Machine-readable identifier of the outage reason. Use this as the discriminator for programmatic handling (e.g., to distinguish permission revocation from network outages or OS-driven kills).
data.outage_description	string	Yes	Long human-readable description of the outage with remediation guidance the worker can follow to resolve it. Phrased for the worker’s perspective.
worker_handle	string	Yes	Unique handle of the worker.
device_id	string	Yes	Unique Identifier of the device which is being used by worker
location	GeoJSON	No	Location in [GeoJSON format] where outage is started

For every outage_code value, see Outage Codes.