Events
This is what the dispatch API will POST to the configured webhook for each set of events. It expects a 2XX response code, or the request will be retried. The retry logic uses an exponential backoff.
Schema
[
{
"event_id": String,
"event_type": String,
"event_time": Date,
"meta": {
"alarm_id": String,
"canceled_by": {
"phone": String
}
}
}
]
The event_id field is the unique identifier for the event.
The event_time field is the timestamp at which the event was received.
The alarm_id field is the unique identifier for the alarm.
The canceled_by field is only present for alarm.status.canceled events, and indicates which phone number authorized the cancellation of the alarm.
The event_type field is the type of event and has at minimum the following possible values:
alarm.status.canceled- Represents the event of the alarm being canceled by the user through the dispatcher via text/call.alarm.closed- Represents the event of the alarm being closed by the dispatcher.alarm.psap_contacted- Represents an outbound call to the PSAP. This event can happen multiple times.
alarm.status.canceled Event Example Body
[
{
"event_id": "5ca21e7b3634a40f00b94454",
"event_type": "alarm.status.canceled",
"event_time": "2019-04-22T17:45:03.092Z",
"meta": {
"alarm_id": "507f191e810c19729de860ea",
"canceled_by": {
"phone": "15554440003"
}
}
}
]
alarm.closed Event Example Body
[
{
"event_id": "5ca21e7b3634a40f00b94454",
"event_type": "alarm.closed,
"event_time": "2019-04-22T17:45:03.092Z",
"meta": {
"alarm_id": "507f191e810c19729de860ea",
}
}
]
alarm.psap_contacted Event Example Body
[
{
"event_id": "5cbdfd07c062772f37d9aaae",
"event_type": "alarm.psap_contacted",
"event_time": "2019-04-22T17:44:09.018Z",
"meta": {
"alarm_id": "507f191e810c19729de860ea"
}
}
]