Event Types

The Webhook endpoint pushes the newly generated external alert(open ands closed) to the customer webhook(API’s providedby customer from where they can listen to).

New external alert will be broadcasted to the customer by the customer provided webhook.

Alert Descriptions

alert_type	device_type impacted	Description	Recommended Action
jam_fault	towel soap sanitizer	Dispenser will not be able to dispense product. This could be caused by tear bar issues, motor stalls or refills are incorrectly loaded.	Remove refill and all excess material or debris. Reinstall refill to clear jam.
sensor_fault	towel soap sanitizer	Sensor out of range, communications fault or handwave sensor issue.	Check for obstructions near handwave sensor, then wipe down hand-wave lens and wipe down sensor lens if it is a towel dispenser.
system_fault	tissue towel soap sanitizer	Device has an internal issue. Device is not functional.	Contact GP/KOLO rep for next steps and device replacement.
battery_out	tissue towel soap sanitizer	Batteries are at critically low level. For automated dispensers (towel, sanitizer and soap) this will result in device not being able to dispense. For non-automated dispensers (tissue) this will result in eventual device_off alert.	Replace the existing batteries with fully charged batteries.
consumable_out	tissue towel soap sanitizer	Refill/consumable is near out or completely out.	Replace the depleted refill with a full refill.
incorrectly_loaded sensor_fault toto_leak toto_safety_check	tissue towel soap sanitizer toto	Other types of external alerts	Other types of external alerts

Webhook Attributes

Attribute	Type	Description
event_type	string	Unique event type of the alert(`alert.resolved`, `alert.created`)
alert_id	string	Unique identifier for this specific alert.
account_id	string	Account Id for which alert is generated
tags	strings	room, floor and building formatted as tags
id	string	Unique identifier for the room, floor, or building
name	string	Name of the room, floor, or building
description	string	Attribute type can be room, floor, or building
device_location_id	string	Unique identifier for the device’s location within the room.
device_macid	[]string	String array identifier for the device’s macid for the alert
alert_status	string	Current status of the alert (e.g., `OPEN`, `CLOSED`)
refill_count	integer	`refill_count` limited to Consumable out and Battery out. For other alerts, it would be 0 Consumable Out : Count would be initialised on the product low or product out. Alert raised on alert preference either low or out - Quad Tissue device type having 4 rolls consumable out or low: Count would be 4 - Quad Tissue device type having 2 rolls consumable out or low: Count would be 2 - Quad Tissue device type having 1 rolls consumable out or low: Count would be 1 Battery Out : Count would be initialised on the depletion state of battery set - Quad Tissue device type having both battery set depleted: Count would be 2 - Vertical Tissue, Towel or any other device type having battery set depleted : Count would be 1
alert_type	string	Type of alert (e.g., `DEVICE_OFF`)
created_date	string	Timestamp of when the alert was created (in milliseconds)
resolved_date	string	Timestamp of when the alert was resolved (in milliseconds), or `null` if still open
resolution_type	string	Describes how the alert was resolved: `resolved`: By a device event `resolved_by_offline`: Auto-resolved due to device going offline `resolved_by_user`: Manually resolved by user

Sample Response

{
    "event_type": "alert.resolved",
    "data": {
        "alert_id": "927486726" ,
        "account_id": "445952",
        "tags": [
          {
            "id": "65568971",
            "name": "High Rise",
            "description": "building"
          },
          {
            "id": "65568973",
            "name": "Floor-3",
            "description": "floor"
          },
          {
            "id": "65569018",
            "name": "Women's Restroom",
            "description": "room"
          }
        ],
        "refill_count": 2,
        "device_location_id" : "66048308",
        "device_macid": ["87jshj86728","57jshj86730"],
        "alert_status": "RESOLVED",
        "alert_type": "BATTERY_OUT",
        "created_date": "2021-12- 14T10:10:20Z",
        "resolved_date": "2021-04-22T10:24:39Z",
        "resolution_type": "RESOLVED_BY_USER"
    }
}

Event Types

Alert Descriptions#

Webhook Attributes#

Sample Response#

Alert Descriptions

Webhook Attributes

Sample Response