Skip to content
uzillion edited this page Jul 7, 2018 · 1 revision

Alerts are an integral feature of this project, yet they are also the least complicated. Alerts have 3 basic components:

  1. The messaging/alerting service API endpoint (in this case Telegram).
  2. The Message Object.
  3. The event described in the Message Object.

Basic Flow of an Alert

  • The message object is built in the place that wants to send an alert, with a mandatory event field.
  • Depending in on what the alert is for the message object can have other arbitrary fields.
  • The event is checked against supported events, and the appropriate message with the supporting information is URL-encoded.
  • This URL-encoded message is attached to the messaging service's API, following which the request is sent to the API.
  • If everything worked perfectly, the alert should appear on the user's end.
Clone this wiki locally