Skip to main content

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.
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.
action_attempt.lock_door.failed A lock door action attempt failed.
action_attempt.unlock_door.succeeded An unlock door action attempt succeeded.
action_attempt.unlock_door.failed An unlock door action attempt failed.
action_attempt.simulate_keypad_code_entry.succeeded A simulate keypad code entry action attempt succeeded.
action_attempt.simulate_keypad_code_entry.failed A simulate keypad code entry action attempt failed.
action_attempt.simulate_manual_lock_via_keypad.succeeded A simulate manual lock via keypad action attempt succeeded.
action_attempt.simulate_manual_lock_via_keypad.failed A simulate manual lock via keypad action attempt failed.

Endpoints

/action_attempts/get Returns a specified action attempt. /action_attempts/list Returns a list of the action attempts that you specify as an array of action_attempt_ids.