Events in managed integration systems
Working with events
An event is a standardized way to proactively learn about changes to a device or its surroundings. It represents a modeled event that the device will send to the cloud to provide information about something that was modified on the device or sensed in its environment. Because these events are modeled, customers can use them in a control flow to react to specific events and the details provided inside of them.
For an event, the mandatory elements are name
and extrinsicId
. The optional elements are description
, extrinsicProperties
, and request
.
Description
The description follows the same format as described in description, with a maximum length of 512 characters.
Request
The request
section is optional and can be omitted if there are no request parameters. If omitted,
the system supports a device sending an event request without any payload by just using the name of the Event. This is used in simple events,
such as a sensor failure on a pump or if the alarm is muted on a smoke or carbon monoxide alarm.
The complex actions need additional parameters. For instance, a request to stream camera footage might include parameters about the streaming protocol to use or whether to send the stream to a specific display device.
For an event request, the mandatory element is parameters
. There are no optional elements.
Response
Event responses are not currently supported.