search
Sign UpSupported Devices
githubEdit

Action Attempts

hashtag
The action_attempt Object

Represents an attempt to perform an action against a device.

hashtag
Properties

action_attempt_id UUID

ID of the action attempt.

status Enum

Status of the action attempt.

chevron-rightEnum valueshashtag

  • pending

  • success

  • error

action_type Enum

Type of the action attempt.

chevron-rightEnum valueshashtag

  • LOCK_DOOR

  • UNLOCK_DOOR

  • SCAN_CREDENTIAL

  • ENCODE_CREDENTIAL

  • RESET_SANDBOX_WORKSPACE

  • SET_FAN_MODE

  • SET_HVAC_MODE

  • ACTIVATE_CLIMATE_PRESET

  • SIMULATE_KEYPAD_CODE_ENTRY

  • SIMULATE_MANUAL_LOCK_VIA_KEYPAD

  • PUSH_THERMOSTAT_PROGRAMS

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.

hashtag
Events

action_attempt.lock_door.succeeded

A lock door action attempt succeeded.

chevron-rightPropertieshashtag

action_attempt_id UUID

ID of the affected action attempt.

action_type String

Type of the action.

created_at Datetime

Date and time at which the event was created.

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.

chevron-rightPropertieshashtag

action_attempt_id UUID

ID of the affected action attempt.

action_type String

Type of the action.

created_at Datetime

Date and time at which the event was created.

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.

chevron-rightPropertieshashtag

action_attempt_id UUID

ID of the affected action attempt.

action_type String

Type of the action.

created_at Datetime

Date and time at which the event was created.

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.

chevron-rightPropertieshashtag

action_attempt_id UUID

ID of the affected action attempt.

action_type String

Type of the action.

created_at Datetime

Date and time at which the event was created.

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.

hashtag
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.

PreviousList Unmanaged Access MethodsNextGet an Action Attempt

Last updated

Was this helpful?