Overview

An alert is a notice to be sent to a user when a particular event occurs. The endpoints alert and alerts manage alerts.

Alert Object

The ampliFi API represents alerts by a JSON object. This table lists properties that may be included in an alert object.

Property	Description	Schema	Example Values
alertTypeId	Name of alert type	string	"alert1"
category	Category of this alert	string	"general"
name	Name of this alert	string	"Credit"
isEnabled	true if alert is enabled	boolean	true or false
descriptionOn	Event that begins alert	string	"On every incoming transfer"
descriptionOff	Event that ends alert	string	"On every incoming transfer"