Subscription to alerts

Description

This action allows to subscribe to alarms associated to sensors.

It’s important to note that we only can subscribe to the sensor data over we own read permission.

http://<your_api_server.com>/subscribe/alarm/<alert_id>
Format json
Method PUT
Permission Read
Returns No additional data returned

Parameters

Key Description Optional
endpoint URL where the platform will send a HTTP request with the alarm message No
secretCallbackKey Secret key for callbacks Yes
retries Maximum number of retries Yes
retries_delay Delay parameter in minutes. Delays are spaced exponentially according to following equation: delay (N) = delay * 2^(N-1) Where N is the current entry turn. More detailed explanation follows. Yes

Retries

In case the remote endpoint is down or does not respond with an success HTTP 2xx code, Sentilo can try to resend the data later. In order to overcome major number of remote outages, Sentilo sends the data in delay times that are exponential according to equation:

delay (N) = delay * 2^(N-1)

For example, if we have a subscription configured with 5 retries and 10 minutes, first retry would occur at 10 minutes, the second 20 minutes after the first, the third 40 minutes after the second, etc up to the fifth retry.

The total time used for the 5 retries would occur in 10+20+40+80+160=310 minutes after the first failed intent.

Response data

This action does not return additional data beyond the HTTP status code.

Examples

Request to subscribe to alert’s alarms

If we want to register a new subscription for alarms belonging to the alert with alert1 identifier, the request will be:

http://<your_api_server.com>/subscribe/alarm/alert1

and the body message:

{"endpoint":"<your_endpoint_notification_server.com>"}