Events

Events allow you to see activity that is taking place within your installation. These could be events which indicate which devices are being unlocked and by whom.

This service is responsible for managing event resources.

For a list of types of events available in the Nebula API, see the section on event types.

name string

Resource name of the event. It must have the format installations/*/events/*. For example: installations/surelock-homes-hq/events/01ARZ3NDEKTSV4RRFFQ69G5FAV.

type string

Type of occurrence which has taken place. Often this attribute is used for routing, observability, policy enforcement, etc.

resource string

This describes the event producer.

create_time timestamp

Timestamp of when the event has been created.

occur_time timestamp

Timestamp of when the occurrence took place. If the time of the occurrence cannot be determined then this attribute is set to the current time by the producer. All producers for the type of event are consistent in this respect.

data struct

The event entry payload, represented as a structure that is expressed as a JSON object.

The event object

name string

Resource name of the event. It must have the format installations/*/events/*. For example: installations/surelock-homes-hq/events/01ARZ3NDEKTSV4RRFFQ69G5FAV.

type string

Type of occurrence which has taken place. Often this attribute is used for routing, observability, policy enforcement, etc.

resource string

This describes the event producer.

create_time timestamp

Timestamp of when the event has been created.

occur_time timestamp

data struct

The event entry payload, represented as a structure that is expressed as a JSON object.

Get an event

Gets an existing event.

Input

name string

The name of the requested event resource.

Output

name string

Resource name of the event. It must have the format installations/*/events/*.

type string

Type of occurrence which has taken place. Often this attribute is used for routing, observability, policy enforcement, etc.

resource string

This describes the event producer.

create_time timestamp

Timestamp of when the event has been created.

occur_time timestamp

data struct

The event entry payload, represented as a structure that is expressed as a JSON object.

List events

Returns a list of events that have been previously created.

Input

parent string

The parent resource name.

page_size integer

The maximum number of items to return.

page_token string

The next_page_token value returned from a previous List request, if any.

filter string

A filter that chooses which events to return.

order_by string

How the results should be sorted.

Output

events array of Event objects

The field name should match the noun events in the method name. There will be a maximum number of items returned based on the page_size field in the request.

next_page_token string

Token to retrieve the next page of results, or empty if there are no more results in the list.