eventobjects containing data of the events occurred in your Uiza account that your applications might be interested in, for instance, a
live_entityis created, a
ingest.keyis reset or a
video_entityis deleted, etc.
While some API requests do not cause any
eventto be created such as Retrieve a live entity, other APIs may generate more than one
event. For example, when you create a live entity, a
live_entity.readyevents will be created consecutively.
eventis created whenever there is a change in the state of an API resource. Therefore, there are
eventscreated without the trigger of any API request. A
live_entity.publishcreated when Uiza receives your live feed signal is triggered by your broadcasting software, not as the result of an API request.
idstringThe unique identifier for the event.
objectstringThe type of the object which is identified by the
id. In this case, the value to the
api_versionstringThe version of the API that were used to trigger the
event. Uiza uses this to ensure the backwards-compatibility of our APIs.
dataobjectThe object containing data of the states at the time of change of impacted resources.
request_idstringThe unique identifier for the API request triggered the event.