Action Attempts
The action_attempt Object
Represents an attempt to perform an action against a device.
Properties
action_attempt_id UUID
ID of the action attempt.
status Enum
Status of the action attempt.
action_type Enum
Type of the action attempt.
Enum values
LOCK_DOORUNLOCK_DOORSCAN_CREDENTIALENCODE_CREDENTIALRESET_SANDBOX_WORKSPACESET_FAN_MODESET_HVAC_MODEACTIVATE_CLIMATE_PRESETSIMULATE_KEYPAD_CODE_ENTRYSIMULATE_MANUAL_LOCK_VIA_KEYPADPUSH_THERMOSTAT_PROGRAMSCONFIGURE_AUTO_LOCK
error Object
Error associated with the action attempt. Null for pending and successful action attempts.
result Object
Result of the action attempt. Null for pending and errored action attempts.
Events
action_attempt.lock_door.succeeded
A lock door action attempt succeeded.
Properties
action_attempt_id UUID
ID of the affected action attempt.
action_type String
Type of the action.
connected_account_id UUID
ID of the connected account associated with the action attempt, if applicable.
created_at Datetime
Date and time at which the event was created.
device_id UUID
ID of the device associated with the action attempt, if applicable.
event_id UUID
ID of the event.
event_type Enum
Value: action_attempt.lock_door.succeeded
occurred_at Datetime
Date and time at which the event occurred.
status String
Status of the action.
workspace_id UUID
ID of the workspace associated with the event.
action_attempt.lock_door.failed
A lock door action attempt failed.
Properties
action_attempt_id UUID
ID of the affected action attempt.
action_type String
Type of the action.
connected_account_id UUID
ID of the connected account associated with the action attempt, if applicable.
created_at Datetime
Date and time at which the event was created.
device_id UUID
ID of the device associated with the action attempt, if applicable.
event_id UUID
ID of the event.
event_type Enum
Value: action_attempt.lock_door.failed
occurred_at Datetime
Date and time at which the event occurred.
status String
Status of the action.
workspace_id UUID
ID of the workspace associated with the event.
action_attempt.unlock_door.succeeded
An unlock door action attempt succeeded.
Properties
action_attempt_id UUID
ID of the affected action attempt.
action_type String
Type of the action.
connected_account_id UUID
ID of the connected account associated with the action attempt, if applicable.
created_at Datetime
Date and time at which the event was created.
device_id UUID
ID of the device associated with the action attempt, if applicable.
event_id UUID
ID of the event.
event_type Enum
Value: action_attempt.unlock_door.succeeded
occurred_at Datetime
Date and time at which the event occurred.
status String
Status of the action.
workspace_id UUID
ID of the workspace associated with the event.
action_attempt.unlock_door.failed
An unlock door action attempt failed.
Properties
action_attempt_id UUID
ID of the affected action attempt.
action_type String
Type of the action.
connected_account_id UUID
ID of the connected account associated with the action attempt, if applicable.
created_at Datetime
Date and time at which the event was created.
device_id UUID
ID of the device associated with the action attempt, if applicable.
event_id UUID
ID of the event.
event_type Enum
Value: action_attempt.unlock_door.failed
occurred_at Datetime
Date and time at which the event occurred.
status String
Status of the action.
workspace_id UUID
ID of the workspace associated with the event.
action_attempt.simulate_keypad_code_entry.succeeded
A simulate keypad code entry action attempt succeeded.
Properties
action_attempt_id UUID
ID of the affected action attempt.
action_type String
Type of the action.
connected_account_id UUID
ID of the connected account associated with the action attempt, if applicable.
created_at Datetime
Date and time at which the event was created.
device_id UUID
ID of the device associated with the action attempt, if applicable.
event_id UUID
ID of the event.
event_type Enum
Value: action_attempt.simulate_keypad_code_entry.succeeded
occurred_at Datetime
Date and time at which the event occurred.
status String
Status of the action.
workspace_id UUID
ID of the workspace associated with the event.
action_attempt.simulate_keypad_code_entry.failed
A simulate keypad code entry action attempt failed.
Properties
action_attempt_id UUID
ID of the affected action attempt.
action_type String
Type of the action.
connected_account_id UUID
ID of the connected account associated with the action attempt, if applicable.
created_at Datetime
Date and time at which the event was created.
device_id UUID
ID of the device associated with the action attempt, if applicable.
event_id UUID
ID of the event.
event_type Enum
Value: action_attempt.simulate_keypad_code_entry.failed
occurred_at Datetime
Date and time at which the event occurred.
status String
Status of the action.
workspace_id UUID
ID of the workspace associated with the event.
action_attempt.simulate_manual_lock_via_keypad.succeeded
A simulate manual lock via keypad action attempt succeeded.
Properties
action_attempt_id UUID
ID of the affected action attempt.
action_type String
Type of the action.
connected_account_id UUID
ID of the connected account associated with the action attempt, if applicable.
created_at Datetime
Date and time at which the event was created.
device_id UUID
ID of the device associated with the action attempt, if applicable.
event_id UUID
ID of the event.
event_type Enum
Value: action_attempt.simulate_manual_lock_via_keypad.succeeded
occurred_at Datetime
Date and time at which the event occurred.
status String
Status of the action.
workspace_id UUID
ID of the workspace associated with the event.
action_attempt.simulate_manual_lock_via_keypad.failed
A simulate manual lock via keypad action attempt failed.
Properties
action_attempt_id UUID
ID of the affected action attempt.
action_type String
Type of the action.
connected_account_id UUID
ID of the connected account associated with the action attempt, if applicable.
created_at Datetime
Date and time at which the event was created.
device_id UUID
ID of the device associated with the action attempt, if applicable.
event_id UUID
ID of the event.
event_type Enum
Value: action_attempt.simulate_manual_lock_via_keypad.failed
occurred_at Datetime
Date and time at which the event occurred.
status String
Status of the action.
workspace_id UUID
ID of the workspace associated with the event.
Endpoints
Returns a specified action attempt.
Returns a list of the action attempts that you specify as an array of action_attempt_ids.
Last updated
Was this helpful?