Wiki

Clone wiki

Numera.LibrisAPI / EventReceiver

Home > Implementing an Event Receiver

Implementing an Event Receiver

At its core, our platform is an event collection and publishing platform. Every Libris device in the field generates a variety of events (or signals for those of you with monitoring centers), from location and status updates to emergency calls. All of these events are captured by the platform and routed to the various services that know how to process those events. You have the ability to determine whether your platform wants to subscribe to all, some, or none of these events as part of your implementation using an event receiver. Events can be sent to more than one endpoint, and are configured and shared at a realm level, similar to the configuration settings.

The device does not transmit all events all of the time. Generally the device will store generated events in a queue that gets transmitted when the device is placed in a charger, a phone call is placed (for a fall or the user presses the button), or thresholds are crossed for certain types of events controlled by configuration (such as 2 hours worth of location updates). In the charger, the device will wake up periodically and transmit any events it has in its queue. There are certain events, such as low battery and low activity alarms which do get transmitted as soon as they are generated.

Events do have various states, but in general most events have a state of "Closed" which means they will not be updated. Some events, such as Classify or Normal events are initially created and then updated for a period of time, and then either "Cancelled" or "Closed" to indicate their final state. Updates to these events are sent to your event receiver, so it is important in your own design to remember that you will receive data for an existing event as an update in certain situations.

What is a Receiver?

An event receiver is nothing more than a web service or endpoint that you implement in your own server environment. The endpoint needs to be accessible to Numera's systems so that as events are published in our platform we can transmit them as quickly as possible to your platform.

What programming language and platform you use for your receiver is entirely up to you, we just need to know the URL, authentication type, and data format you want to use.

Authentication for the Receiver

In order for you to validate it is Numera sending you event data, we offer a couple of different authentication mechanisms out of the box, and we can customize something unique to your platform. Please contact our implementation team for details on the options.

Event Data Formats

We have integrated with several off-the-shelf packages for call centers as well as several custom monitoring packages. We can offer you several different formats for the Event Data, so please contact your implementation team for details on the options.

Every event has a different schema that you can find detailed in the Event Dictionary.

Updated