Alarm Push

Trusted Web API

Alarm Push service sends a data-package when an available alarm on an accessible unit is triggered. The data-package is a collection of AlarmPushDataModel, which is sent using the chosen Method and supplied MethodDestination.

To start receving Alarm Push data-packages, a subscription must be created through the 'CreateAlarmPushSubscription' endpoint.

In order to see which alarm an AlarmId represents, refer to the 'GetAlarmDefinitions' endpoint.

Requirements

Your service receving the data-package is expected to reply with the appropriate success code corresponding to the chosen Method. For instance, using 'HTTP POST' method, it is expected to a Http Status Code 200 (OK)

Available methods


1. HTTP POST

The HTTP POST has the id of 1 and sends a collection of AlarmPushDataModel through HTTP POST to the specified destination. The MethodDesitination for this method is a web url ready to recieve the data model, such as https://domainname.tld/endpoint.

This method expects a Http Status Code 200 (OK) as response.

Suspension

All other responses, or failure to reply, will result in the message being resent every 60 seconds. After 10 reply failures, the subscription will be suspended, meaning that only a single test push message will be sent once every 2 minutes. When the appropriate succes code is returned, the subscription will automatically be unsuspended, and normal push operation resumed. A warning email will be sent upon both suspension and unsuspension.