Class EventObject
- Namespace
- OverKizApi.Models
- Assembly
- OverKizApi.dll
An event pushed to a registered event listener by the Overkiz gateway or cloud.
The meaningful fields depend on the event type — check Name (mapped from EventName)
before reading type-specific fields.
public sealed class EventObject
- Inheritance
-
EventObject
- Inherited Members
Properties
CameraId
Camera identifier for camera-related events.
[JsonPropertyName("cameraId")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? CameraId { get; init; }
Property Value
- string
Camera identifier for camera-related events.
ConditionGroupoid
OID of the condition group that triggered this event.
[JsonPropertyName("conditionGroupoid")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? ConditionGroupoid { get; init; }
Property Value
- string
OID of the condition group that triggered this event.
DeletedRawDevicesCount
Number of raw device records deleted during a synchronisation event.
[JsonPropertyName("deletedRawDevicesCount")]
[JsonNumberHandling(JsonNumberHandling.AllowReadingFromString)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public int? DeletedRawDevicesCount { get; init; }
Property Value
- int?
Number of raw device records deleted during a synchronisation event.
DeviceStates
Changed state snapshots included in a DeviceStateChanged event.
[JsonPropertyName("deviceStates")]
public IReadOnlyList<EventState> DeviceStates { get; init; }
Property Value
- IReadOnlyList<EventState>
Changed state snapshots included in a
DeviceStateChangedevent.
DeviceUrl
Device URL of the device that triggered the event (present on device events).
[JsonPropertyName("deviceURL")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? DeviceUrl { get; init; }
Property Value
- string
Device URL of the device that triggered the event (present on device events).
ExecId
Execution ID associated with this event (present on execution state-change events).
[JsonPropertyName("execId")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? ExecId { get; init; }
Property Value
- string
Execution ID associated with this event (present on execution state-change events).
FailedCommands
Vendor-defined failed-command details as CLR primitives, lists or dictionaries; the structure varies by firmware.
[JsonPropertyName("failedCommands")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonConverter(typeof(DeviceValueConverter))]
public object? FailedCommands { get; init; }
Property Value
- object
Vendor-defined failed-command details as CLR primitives, lists or dictionaries; the structure varies by firmware.
FailureType
Failure type string as returned by the API (use FailureTypeCode for the parsed enum).
[JsonPropertyName("failureType")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? FailureType { get; init; }
Property Value
- string
Failure type string as returned by the API (use FailureTypeCode for the parsed enum).
FailureTypeCode
Parsed failure type code for failed-execution events.
[JsonPropertyName("failureTypeCode")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public FailureType? FailureTypeCode { get; init; }
Property Value
- FailureType?
Parsed failure type code for failed-execution events.
GatewayId
Serial number of the gateway that generated the event.
[JsonPropertyName("gatewayId")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? GatewayId { get; init; }
Property Value
- string
Serial number of the gateway that generated the event.
Label
Human-readable label associated with the event (e.g. scenario name).
[JsonPropertyName("label")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Label { get; init; }
Property Value
- string
Human-readable label associated with the event (e.g. scenario name).
Metadata
Arbitrary metadata string attached to the event.
[JsonPropertyName("metadata")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Metadata { get; init; }
Property Value
- string
Arbitrary metadata string attached to the event.
Name
Event name string as returned by the API (see EventName for known values).
[JsonPropertyName("name")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Name { get; init; }
Property Value
NewState
New execution state (present on ExecutionStateChanged events).
[JsonPropertyName("newState")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public ExecutionState? NewState { get; init; }
Property Value
- ExecutionState?
New execution state (present on
ExecutionStateChangedevents).
OldState
Previous execution state (present on ExecutionStateChanged events).
[JsonPropertyName("oldState")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public ExecutionState? OldState { get; init; }
Property Value
- ExecutionState?
Previous execution state (present on
ExecutionStateChangedevents).
OwnerKey
Owner key of the principal that triggered the execution.
[JsonPropertyName("ownerKey")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? OwnerKey { get; init; }
Property Value
- string
Owner key of the principal that triggered the execution.
PlaceOid
OID of the place associated with this event.
[JsonPropertyName("placeOid")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? PlaceOid { get; init; }
Property Value
- string
OID of the place associated with this event.
ProtocolType
Protocol type string for protocol-synchronisation events.
[JsonPropertyName("protocolType")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? ProtocolType { get; init; }
Property Value
- string
Protocol type string for protocol-synchronisation events.
Setupoid
OID of the setup this event relates to.
[JsonPropertyName("setupoid")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Setupoid { get; init; }
Property Value
- string
OID of the setup this event relates to.
SubType
Raw event sub-type integer as returned by the API.
[JsonPropertyName("subType")]
[JsonNumberHandling(JsonNumberHandling.AllowReadingFromString)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public int? SubType { get; init; }
Property Value
- int?
Raw event sub-type integer as returned by the API.
TimeToNextState
Estimated seconds until the next scheduled state transition.
[JsonPropertyName("timeToNextState")]
[JsonNumberHandling(JsonNumberHandling.AllowReadingFromString)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public int? TimeToNextState { get; init; }
Property Value
- int?
Estimated seconds until the next scheduled state transition.
Timestamp
Unix epoch millisecond timestamp when the event occurred, or null if not provided.
[JsonPropertyName("timestamp")]
[JsonNumberHandling(JsonNumberHandling.AllowReadingFromString)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public long? Timestamp { get; init; }
Property Value
Type
Raw event type integer as returned by the API.
[JsonPropertyName("type")]
[JsonNumberHandling(JsonNumberHandling.AllowReadingFromString)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public int? Type { get; init; }
Property Value
- int?
Raw event type integer as returned by the API.