diff --git a/doc/Extensions/Alerting.md b/doc/Extensions/Alerting.md index 253c90cc0..8b0f25675 100644 --- a/doc/Extensions/Alerting.md +++ b/doc/Extensions/Alerting.md @@ -16,6 +16,7 @@ Table of Content: - [HipChat](#transports-hipchat) - [PagerDuty](#transports-pagerduty) - [Pushover](#transports-pushover) + - [Boxcar](#transports-boxcar) - [Entities](#entities) - [Devices](#entity-devices) - [BGP Peers](#entity-bgppeers) @@ -309,6 +310,26 @@ $config['alert']['transports']['pushover'][] = array( ); ``` +## Boxcar + +Enabling Boxcar support is super easy. +Copy your access token from the Boxcar app or from the Boxcar.io website and setup the transport in your config.php like: + +```php +$config['alert']['transports']['boxcar'][] = array( + "access_token" => 'ACCESSTOKENGOESHERE', + ); +``` + +To modify the Critical alert sound, add the 'sound_critical' parameter, example: + +```php +$config['alert']['transports']['boxcar'][] = array( + "access_token" => 'ACCESSTOKENGOESHERE', + "sound_critical" => 'detonator-charge', + ); +``` + # Entities Entities as described earlier are based on the table and column names within the database, if you are ensure of what the entity is you want then have a browse around inside MySQL using `show tables` and `desc `.