Skip to main content

​
Overview

Seam enables you to lock or unlock your door lock remotely. This guide walks you through how to perform these actions using the Seam API. When you send a command to a smart lock, it might take a while for Seam to confirm the action’s success. To handle this, Seam provides an “action attempt” object, which indicates whether the action was successful. To ensure that the action has been successfully executed, we advise checking the status of the action attempt object by polling the “Get Action Attempt” request. Once Seam has successfully confirmed the action, the action attempt’s status will indicate success. Some providers and device models cannot confirm whether the physical lock or unlock happened in a reasonable time or at all. In those cases, a successful action attempt can still include action_attempt.result.was_confirmed_by_device = false.

​
Before You Begin: Confirm Capabilities

Before you attempt to lock or unlock a device, be sure to confirm that your device has the capability to perform these operations. You can inspect the capabilities of a device by checking the following capability flags for the device:
  • device.can_remotely_lock
  • device.can_remotely_unlock
Use Get Device for a specific device to return these capability flags. Then, use an if statement or similar check to confirm that the relevant flag is both present and true before attempting to lock or unlock the device. If either of these capability flags is false or not present, you can view the properties of the device, errors or warnings for the device, and events related to the device to learn more about the cause of these issues. For example, you could examine device.properties.online. In addition, you could look for a device.disconnected event.
Request:
await seam.devices.get('11111111-1111-1111-1111-444444444444')
Response:
{
  device_id: '11111111-1111-1111-1111-444444444444',
  can_remotely_lock: true,   // You can use seam.locks.lockDoor() on this device.
  can_remotely_unlock: true, // You can use seam.locks.unlockDoor() on this device.
  ...
}

​
Locking a Door

You can lock a door using the lock_door endpoint. To confirm the success of the action, see Verifying the success of a lock or unlock action.
Request:
// Get the device.
const device = await seam.devices.get({
  device_id: '11111111-1111-1111-1111-444444444444',
})

// Confirm that the device can remotely lock.
if (device.can_remotely_lock) {
  // Perform the lock operation.
  await seam.locks.lockDoor({
    device_id: device.device_id,
  })
}
Response:
{
  "actionAttempt": {
    "status": "success",
    "action_attempt_id": "11111111-2222-3333-4444-555555555555",
    "action_type": "LOCK_DOOR",
    "result": {},
    "error": null
  }
}

​
Unlocking a Door

You can unlock a door using the unlock_door endpoint. To confirm the success of the action, see Verifying the success of a lock or unlock action.
Request:
// Get the device.
const device = await seam.devices.get({
  device_id: '11111111-1111-1111-1111-444444444444',
})

// Confirm that the device can remotely unlock.
if (device.can_remotely_unlock) {
  // Perform the unlock operation.
  await seam.locks.unlockDoor({
    device_id: device.device_id,
  })
}
Response:
{
  "actionAttempt": {
    "status": "success",
    "action_attempt_id": "11111111-2222-3333-4444-555555555555",
    "action_type": "UNLOCK_DOOR",
    "result": {
      "was_confirmed_by_device": false
    },
    "error": null
  }
}

​
Verifying the Success of a Lock or Unlock Action

​
1. Execute a Lock request (or other action)

When initiating a lock or unlock action, the Seam API returns an action attempt, which monitors the success or failure of the action.
Request:
await seam.locks.lockDoor({
  device_id: '11111111-1111-1111-1111-444444444444',
})
Response:
{
  "actionAttempt": {
    "status": "success",
    "action_attempt_id": "11111111-2222-3333-4444-555555555555",
    "action_type": "LOCK_DOOR",
    "result": {},
    "error": null
  }
}

​
2. Poll the Action Attempt to Verify the Success of the Action

Use the action_attempt_id from the prior response to make a Get Action Attempt request. When the action attempt’s status changes to success, it indicates the action has been successful.
Some providers and device models do not confirm whether a lock or unlock completed on the physical device. In those cases, the action attempt can still succeed while action_attempt.result.was_confirmed_by_device is false. Use this property to set the right expectation in your UI, especially for unlock flows.
Request:
await seam.actionAttempts.get({
  action_attempt_id: '11111111-2222-3333-4444-555555555555',
})
Response:
{
  "status": "success",
  "action_attempt_id": "11111111-2222-3333-4444-555555555555",
  "action_type": "LOCK_DOOR",
  "result": {
    "was_confirmed_by_device": true
  },
  "error": null
}

​
Checking the Locked Status of a Lock

To retrieve the locked status of a specific door lock, use the Get Device endpoint by providing the device_id of the desired lock. This operation returns detailed information, including the current locked status. Note that if the lock is offline, Seam does not return the device.locked property.
Request:
await seam.devices.get('11111111-1111-1111-1111-444444444444')
Response:
{
  device_id: '11111111-1111-1111-1111-444444444444',
  properties: {
    locked: true,
    ...
  },
  ...
}

​
Lock and Unlock Events

Whenever a lock is locked or unlocked, Seam emits a lock.locked or lock.unlocked event. You can see these events by making a List Events request or by setting up a webhook. For more information on how to set up webhooks, see the Webhooks guide. A lock or unlock event looks like the following: 
{
  "event": {
    "event_id": "22222222-3333-4444-5555-666666666666",
    "device_id": "11111111-1111-1111-1111-444444444444",
    "event_type": "lock.locked",
    "workspace_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2023-10-13T15:10:18.443Z",
    "occurred_at": "2023-10-13T15:09:08.531Z",
    "method": "unknown",
    "connected_account_id": "11111111-1111-1111-1111-222222222222"
  },
  "ok": true
}
For more information about the lock.locked and lock.unlocked attributes, please see Events.