Event types in Nebula

Overview

Events allow you to see activity that is taking place within your installation. For example, these could be events which indicate which access points are being unlocked and by whom.

This section aims to detail the types of events that are currently available in the Nebula API. We may add more at any time, so in developing and maintaining your code, you should not assume that only these types exist.

See also the documentation for the events service.

Event types

You'll notice that these events generally follow the pattern: {{resource}}{{event}}. For example: accesspointcreated. Our goal is to design a consistent system that makes things easier to anticipate and code against.

List of events

All event type names use the fully qualified name.

com.saltosystems.nebula.event.v1.accesspointcreated

Event representing the creation of an access point.

com.saltosystems.nebula.event.v1.accesspointupdated

Event representing the update of an access point.

com.saltosystems.nebula.event.v1.accesspointdeleted

Event representing the deletion of an access point.

com.saltosystems.nebula.event.v1.accesspointunlocked

Event representing the unlocking of an access point. Includes the access point that's been unlocked: salto.nebula.accesspoint.v1.AccessPoint and the user who unlocked the access point: salto.nebula.user.v1.User

com.saltosystems.nebula.event.v1.accesspointlocked

Event representing the locking of an access point. Includes the access point that's been locked: salto.nebula.accesspoint.v1.AccessPoint and the user who locked the access point salto.nebula.user.v1.User.

com.saltosystems.nebula.event.v1.accesspointforcedopen

Event representing a forced open of an access point. That's to say, the access point has been unlocked without using a valid key.

com.saltosystems.nebula.event.v1.accesspointclosed

Event representing the closing of an access point. This event might not be triggered with all access point closures, but only with those that happen after events such as access point left open or forced open.

com.saltosystems.nebula.event.v1.accessdenied

Event representing a denied access to a user by an access point. Includes, the access point that denied access: salto.nebula.accesspoint.v1.AccessPoint and the user whose access was rejected: salto.nebula.user.v1.User.

com.saltosystems.nebula.event.v1.accesspointleftopen

Event representing the detection of an access point that's been left open.

com.saltosystems.nebula.event.v1.accessrightcreated

Event representing the creation of an access right.

com.saltosystems.nebula.event.v1.accessrightupdated

Event representing the update of an access right.

com.saltosystems.nebula.event.v1.accessrightdeleted

Event representing the deletion of an access right.

com.saltosystems.nebula.event.v1.accessrightaccesspointcreated

Event representing the creation of an access right's access point association. Includes the creation of the access point's access right association: salto.nebula.accessright.v1.AccessRight and the Access right's access point association: salto.nebula.accesspoint.v1.AccessPoint.

com.saltosystems.nebula.event.v1.accessrightaccesspointdeleted

Event representing the deletion of an access right's access point association. Includes the deletion of the access point's access right association: salto.nebula.accessright.v1.AccessRight and the access right's access point association: salto.nebula.accesspoint.v1.AccessPoint.

com.saltosystems.nebula.event.v1.usercreated

Event representing the creation of a user.

com.saltosystems.nebula.event.v1.userupdated

Event representing the update of a user.

com.saltosystems.nebula.event.v1.userblocked

Event representing the blocking of a user. See more on blocking and unblocking users in the user guide.

com.saltosystems.nebula.event.v1.userunblocked

Event representing the unblocking of a user. See more on blocking and unblocking users in the user guide.

com.saltosystems.nebula.event.v1.userdeleted

Event representing the deletion of a user.

com.saltosystems.nebula.event.v1.useraccessrightcreated

Event representing the creation of a user's access right association. Includes the access right's user association: salto.nebula.user.v1.User and the user's access right association: salto.nebula.accessright.v1.AccessRight.

com.saltosystems.nebula.event.v1.useraccessrightupdated

Event representing the update of a user's access right association. Includes the access right's user association: salto.nebula.user.v1.User and the user's access right association: salto.nebula.accessright.v1.AccessRight.

com.saltosystems.nebula.event.v1.useraccessrightdeleted

Event representing the deletion of a user's access right association. Includes the access right's user association: salto.nebula.user.v1.User and the user's access right association: salto.nebula.accessright.v1.AccessRight.

com.saltosystems.nebula.event.v1.cardkeyassigned

Event representing the assignment of a user's card key. Includes the card key's user: salto.nebula.user.v1.User and the card key assigned: salto.nebula.user.v1.CardKey.

com.saltosystems.nebula.event.v1.cardkeycanceled

Event representing the cancelation of a user's card key. Includes the card key's user: salto.nebula.user.v1.User and the card key canceled: salto.nebula.user.v1.CardKey.

com.saltosystems.nebula.event.v1.appkeyassigned

Event representing the assignment of a user's app key. Includes the app key's user: salto.nebula.user.v1.User and the app key assigned: salto.nebula.user.v1.AppKey

com.saltosystems.nebula.event.v1.appkeycanceled

Event representing the cancelation of a user's app key. Includes the app key's user: salto.nebula.user.v1.User and the app key canceled: salto.nebula.user.v1.AppKey.

com.saltosystems.nebula.event.v1.walletkeyassigned

Event representing the assignment of a user's wallet key. Includes the wallet key's user: salto.nebula.user.v1.User and the wallet key assigned: salto.nebula.user.v1.WalletKey.

com.saltosystems.nebula.event.v1.walletkeycanceled

Event representing the cancelation of a user's wallet key. Includes the wallet key's user: salto.nebula.user.v1.User and the wallet key canceled: salto.nebula.user.v1.WalletKey.

com.saltosystems.nebula.event.v1.unitmovedin

Event representing the move in of a unit. See the documentation on units for more information.

com.saltosystems.nebula.event.v1.unitmovedout

Event representing the move out of a unit. See the documentation on units for more information.

com.saltosystems.nebula.event.v1.unitcreated

Event representing the creation of a unit. See the documentation on units for more information.

com.saltosystems.nebula.event.v1.unitupdated

Event representing the update of a unit. See the documentation on units for more information.

com.saltosystems.nebula.event.v1.unitdeleted

Event representing the deletion of a unit. See the documentation on units for more information.