Matrix Event Bus (MEB)
What is the Matrix Event Bus ?
The purpose of Matrix Event Bus (MEB) is to stream events from various applications running in a property or organisation and deliver it to certain endpoints on a near-real time basis. Subscribers can subscribe to a pattern (subset) or entirety of events. Billing is calculated based on the amount of data egress and certain other key parameters of deliveries.
Using MEB, third party application developers can plugin their solutions within Matrix and add value within the eco-system. For example, an application listening to all incident creations can notify another application within their organisation about the same by subscribing to a pattern:
matrix.<mybuildingid>.scworkforcemanagement.INCIDENT_CREATED.*
What are events ?
Each application within Matrix, when it acts on certain key entities, results in a create, modify, delete or read event with respect to the namespace within that application. For example, when a new incident is created within Matrix, its RoutingKey is as follows: matrix.mybuildingid.scworkforcemanagement.INCIDENT_CREATED.HIGH
Additionally, an event will also contain a generally complete subset of affected object’s data for providing minimal information about the event. For example, a new incident creation event will also proxy the details about the zone, name of task, who it is allocated to. Any other information not present within the event payload can be obtained by appropriate SDK calls to Matrix.
The routing key of an event has the following generic schema:
matrix.<principal>.<module>.<eventid>.<priority>
Can I generate events from my application and send it to MEB ?
Yes, third party applications can generate their own events within the event bus, subject to certain restrictions and quotas.
Example of event pushed using MEB
- New Incident Created - matrix.mybuildingid.scworkforcemanagement.INCIDENT_CREATED.HIGH
General Data Format for Matrix Events
Each event in the MEB follows the following schema:
"Principal": "<string> The principal - property, building or organisation",
"Description": "<string> A human readable description of the event.",
"Event": "<string> The eventid part of routing key of this matrix event.",
"RoutingKey": "<string> The routing key.",
"Module": "<string> The module part of routing key of this matrix event.",
"Status": "<string> The priority part of routing key of this matrix event.",
"UnixTime": "<string> The unix time of this event in seconds.",
"UnixTimeInt": "<number> The unit time of this event in seconds as number datatype."
"Meta": "<map> A variadic data structure holding a subset of relevant data pertaining to this event."
The schema of key Meta is constant per source namespace that generated the event.