HoxtonAi
Powered by Redocly

Alert

APIs to manage an organisation's alerts.

Create/Update alert

Update an alert if it exists, create a new one otherwise.

Securityo_auth
Request
Request Body schema: application/json
required

The configuration for an alert to store.

alertType
required
string
Enum: "offline_alert" "occupancy_alert" "camera_health_summary_alert" "people_count"
configurationDetails
object
emails
Array of strings or null <email> non-empty
id
string or null <uuid>
name
required
string
organisationId
required
string <uuid>
siteId
string or null <uuid>
state
string
Enum: "active" "deleted"
webhook
object
Responses
201

OK.

204

OK.

400

Bad request.

401

Authentication failed.

403

Not allowed.

410

Gone.

422

Unprocessable entity.

500

Failed.

501

Not implemented.

put/alerts
Request samples
application/json
{
  • "alertType": "offline_alert",
  • "configurationDetails": { },
  • "emails": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
  • "state": "active",
  • "webhook": { }
}
Response samples
application/json
{
  • "alertType": "offline_alert",
  • "configurationDetails": { },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "emails": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
  • "state": "active",
  • "webhook": { }
}

Delete alert

Delete an alert.

Securityo_auth
Request
path Parameters
alertId
required
string <uuid>

The ID of the alert to be deleted.

Responses
204

OK.

400

Bad request.

401

Authentication failed.

403

Not allowed.

404

Not found.

410

Gone.

422

Unprocessable entity.

500

Failed.

501

Not implemented.

delete/alerts/{alertId}
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string"
}
Get alert
Get an alert identified by its id.


Securityo_auth 
Request 
path Parameters
alertId
required
string <uuid> 
The ID of the alert to get.


 
Responses 
200
OK.


401
Authentication failed.


403
Not allowed.


404
Not found.


422
Unprocessable entity.


500
Failed.


501
Not implemented.


get/alerts/{alertId}
Request samples 
Response samples 
application/json
{
  • "alertType": "offline_alert",
  • "configurationDetails": { },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "emails": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
  • "state": "active",
  • "webhook": { }
}
List alerts
Get all available alerts subject to filters.


Securityo_auth 
Request 
query Parameters
alertType
string
The ID of a camera linked to the Alerts.


 Enum: "offline_alert" "occupancy_alert" "camera_health_summary_alert"  
cameraPositionId
string <uuid> 
The ID of a camera position linked to the alerts.


 
notificationGroupId
string <uuid> 
The ID of the notification group the alert are sent to.


 
organisationId
string <uuid> 
The ID of the associated organisation.


 
occupancyMonitorId
string <uuid> 
The ID of the associated occupancy monitor.


 
siteId
string <uuid> 
The ID of the associated site.


 
state
string
Alert state.


 Enum: "active" "deleted"  
Responses 
200
OK.


401
Authentication failed.


403
Not allowed.


422
Unprocessable entity.


500
Failed.


501
Not implemented.


get/alerts
Request samples 
Response samples 
application/json
[
  • {
    }
]