Alarm Object

🚧

Sandbox Environment

For testing, use https://api-sandbox.noonlight.com/platform/v1 as the base URL.

Attributes

Description

Example

id string

ID for the alarm

507f191e810c19729de860ea

status
string

Current status of the alarm
Can be eitherACTIVE or CANCELED

ACTIVE

services
object

Services for the alarm

{
  "police": true,
  "fire": false,
  "medical": false
}

locations
object

Current and previous locations of the alarm given using either address or coordinates.

{
  "adresses": [{
    "line1": "1234 9th Ave", 
    "line2": "Unit 302", 
    "city": "San Diego", 
    "state": "CA", 
    "zip": "92101",
    "created_at": "2017-09-23T18:01:50Z"
  }],
  "coordinates": [{
    "lat": 34.32334,
    "lng": -117.3343,
    "accuracy": 5,
    "created_at": "2017-09-23T17:59:02Z"
  }]
}

created_at
string

Time the alarm was created

2017-09-23T17:59:02Z

📘

Alarm Metadata

If you have additional contextual information to send with alarms, contact us to enable it for your account.