Locks

Devices that are able to be locked and unlocked.

List of Methods

Lock a Lock	Lock a Lock
Unlock a Lock	Unlock a Lock
List Locks	List Locks

Learn about locking and unlocking actions.

Events

lock.locked

A door lock has been locked.

method enum

Present on lock.locked and lock.unlocked events. Specifies the method used to perform the lock or unlock action.

Supported values for lock.unlocked:

• keycode

• manual

• unknown

• seamapi

Supported values for lock.locked:

• keycode

• manual

• unknown

• seamapi

• automatic (for Kwikset and igloohome only)

access_code_id string

Specifies the unique identifier of the access code used to trigger this event. Seam includes this ID in the event if the affected device returns this information. For a list of device manufacturers that send the access_code_id in lock events, see Linking Unlock Events and Access Codes.

lock.unlocked

A door lock has been unlocked.

method enum

Present on lock.locked and lock.unlocked events. Specifies the method used to perform the lock or unlock action.

Supported values for lock.unlocked:

• keycode

• manual

• unknown

• seamapi

Supported values for lock.locked:

• keycode

• manual

• unknown

• seamapi

• automatic (for Kwikset and igloohome only)

access_code_id string

Specifies the unique identifier of the access code used to trigger this event. Seam includes this ID in the event if the affected device returns this information. For a list of device manufacturers that send the access_code_id in lock events, see Linking Unlock Events and Access Codes.

lock.access_denied

An incorrect access code was entered one or more times in a row on a device (Kwikset and igloohome only).

access_code_id string

Specifies the unique identifier of the access code used to trigger this event. Seam includes this ID in the event if the affected device returns this information. For a list of device manufacturers that send the access_code_id in lock events, see Linking Unlock Events and Access Codes.