GET /v1/customers/:id/alarm

Returns the current alarm opened for the current customer. Fails if no alarm was found, or all opened alarms for this customer have been closed.

The provided id id the global id Invisible Collector assigned to the customer when it was first registered;

Optionally a create flag can be provided which will automatically create and open a new alarm if none is found.

curl -XGET \
  --header "Content-Type: application/json" \
  --header "Authorization: Bearer 4a415cc660e67d8f4d26d5a7f390183a86fc3a4524ded78dc2448e86c48b2739" \
  https://api.invisiblecollector.com/v1/customers/2314234/alarm
require "net/https"
require "uri"

uri = URI.parse("https://api.invisiblecollector.com/v1/customers/2314234/alarm")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri.request_uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer 4a415cc660e67d8f4d26d5a7f390183a86fc3a4524ded78dc2448e86c48b2739'

response = http.request(request)

This request will return, for example, the following JSON response:

{
  "gid": "1fb0c683-bedc-45be-a88a-ff76da7bf650",
  "status": "OPEN",
  "createdAt": "2018-05-02",
  "updatedAt": "2018-05-04",
  "events": [
    {
      "origin": "[email protected]",
      "destination": "[email protected]",
      "gid": "11234567-bedc-45be-a88a-ff76da7bf650",
      "messageType": "EMAIL",
      "message": "hello email body"
    }
  ]
}

Endpoint

GET https://api.invisiblecollector.com/v1/customers/:id/alarm

Response body

Alarm

Attribute Type Description
id string An unique identifier of this alarm
status string The current status of this alarm
createdAt date The date this alarm was created in ISO 8601 format
updatedAt date The last update made to this alarm in ISO 8601 format
events array A list of events associated with this alarm

Errors

This endpoint may return the following errors

HTTP Code Description
401 Unauthorized Invalid credentials were supplied
404 Not found Either the customer was not found or no opened alarm was found.