The Action Attempt Object

{
  "action_attempt_id": "3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f",
  "action_type": "LOCK_DOOR",
  "error": null,
  "result": {},
  "status": "success"
}

{
  "action_attempt_id": "3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f",
  "action_type": "LOCK_DOOR",
  "error": null,
  "result": {},
  "status": "success"
}

The action_attempt Object

Represents an attempt to perform an action against a device.

{
  "action_attempt_id": "3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f",
  "action_type": "LOCK_DOOR",
  "error": null,
  "result": {},
  "status": "success"
}

Properties

String (UUID)

required

ID of the action attempt.

Enum (String)

required

Status of the action attempt.

Enum values

pending
success
error

Enum (String)

required

Type of the action attempt.

Enum values

LOCK_DOOR
UNLOCK_DOOR
SCAN_CREDENTIAL
ENCODE_CREDENTIAL
SCAN_TO_ASSIGN_CREDENTIAL
ASSIGN_CREDENTIAL
RESET_SANDBOX_WORKSPACE
SET_FAN_MODE
SET_HVAC_MODE
ACTIVATE_CLIMATE_PRESET
ACTIVATE_WEEKLY_PROGRAM
SIMULATE_KEYPAD_CODE_ENTRY
SIMULATE_MANUAL_LOCK_VIA_KEYPAD
PUSH_THERMOSTAT_PROGRAMS
CONFIGURE_AUTO_LOCK
CONVERT_ACCESS_CODE_TO_MANAGED

Object or null

required

Error associated with the action attempt. Null for pending and successful action attempts.

Object or null

required

Result of the action attempt. Null for pending and errored action attempts.

Getting Started

Granting Access

Devices and Systems

Setup

Monitoring

Low-Level APIs

The Action Attempt Object

The action_attempt Object

Properties