Action Attempt Events

`action_attempt.lock_door.succeeded`

A lock door action attempt succeeded.

{
  "action_attempt_id": "00000000-0000-0000-0000-000000000000",
  "action_type": "",
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "A lock door action attempt succeeded.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "action_attempt.lock_door.succeeded",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "status": "",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

action_attempt_id

String (UUID)

ID of the affected action attempt.

action_type

String

Type of the action.

connected_account_id

String (UUID)

ID of the connected account associated with the action attempt, if applicable.

created_at

String (ISO 8601)

Date and time at which the event was created.

device_id

String (UUID)

ID of the device associated with the action attempt, if applicable.

event_description

String

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: action_attempt.lock_door.succeeded

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

status

String

Status of the action.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`action_attempt.lock_door.failed`

A lock door action attempt failed.

{
  "action_attempt_id": "00000000-0000-0000-0000-000000000000",
  "action_type": "",
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "A lock door action attempt failed.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "action_attempt.lock_door.failed",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "status": "",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

action_attempt_id

String (UUID)

ID of the affected action attempt.

action_type

String

Type of the action.

connected_account_id

String (UUID)

ID of the connected account associated with the action attempt, if applicable.

created_at

String (ISO 8601)

Date and time at which the event was created.

device_id

String (UUID)

ID of the device associated with the action attempt, if applicable.

event_description

String

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: action_attempt.lock_door.failed

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

status

String

Status of the action.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`action_attempt.unlock_door.succeeded`

An unlock door action attempt succeeded.

{
  "action_attempt_id": "00000000-0000-0000-0000-000000000000",
  "action_type": "",
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "An unlock door action attempt succeeded.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "action_attempt.unlock_door.succeeded",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "status": "",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

action_attempt_id

String (UUID)

ID of the affected action attempt.

action_type

String

Type of the action.

connected_account_id

String (UUID)

ID of the connected account associated with the action attempt, if applicable.

created_at

String (ISO 8601)

Date and time at which the event was created.

device_id

String (UUID)

ID of the device associated with the action attempt, if applicable.

event_description

String

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: action_attempt.unlock_door.succeeded

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

status

String

Status of the action.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`action_attempt.unlock_door.failed`

An unlock door action attempt failed.

{
  "action_attempt_id": "00000000-0000-0000-0000-000000000000",
  "action_type": "",
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "An unlock door action attempt failed.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "action_attempt.unlock_door.failed",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "status": "",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

action_attempt_id

String (UUID)

ID of the affected action attempt.

action_type

String

Type of the action.

connected_account_id

String (UUID)

ID of the connected account associated with the action attempt, if applicable.

created_at

String (ISO 8601)

Date and time at which the event was created.

device_id

String (UUID)

ID of the device associated with the action attempt, if applicable.

event_description

String

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: action_attempt.unlock_door.failed

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

status

String

Status of the action.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`action_attempt.simulate_keypad_code_entry.succeeded`

A simulate keypad code entry action attempt succeeded.

{
  "action_attempt_id": "00000000-0000-0000-0000-000000000000",
  "action_type": "",
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "A simulate keypad code entry action attempt succeeded.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "action_attempt.simulate_keypad_code_entry.succeeded",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "status": "",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

action_attempt_id

String (UUID)

ID of the affected action attempt.

action_type

String

Type of the action.

connected_account_id

String (UUID)

ID of the connected account associated with the action attempt, if applicable.

created_at

String (ISO 8601)

Date and time at which the event was created.

device_id

String (UUID)

ID of the device associated with the action attempt, if applicable.

event_description

String

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: action_attempt.simulate_keypad_code_entry.succeeded

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

status

String

Status of the action.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`action_attempt.simulate_keypad_code_entry.failed`

A simulate keypad code entry action attempt failed.

{
  "action_attempt_id": "00000000-0000-0000-0000-000000000000",
  "action_type": "",
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "A simulate keypad code entry action attempt failed.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "action_attempt.simulate_keypad_code_entry.failed",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "status": "",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

action_attempt_id

String (UUID)

ID of the affected action attempt.

action_type

String

Type of the action.

connected_account_id

String (UUID)

ID of the connected account associated with the action attempt, if applicable.

created_at

String (ISO 8601)

Date and time at which the event was created.

device_id

String (UUID)

ID of the device associated with the action attempt, if applicable.

event_description

String

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: action_attempt.simulate_keypad_code_entry.failed

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

status

String

Status of the action.

workspace_id

String (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.

{
  "action_attempt_id": "00000000-0000-0000-0000-000000000000",
  "action_type": "",
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "A simulate manual lock via keypad action attempt succeeded.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "action_attempt.simulate_manual_lock_via_keypad.succeeded",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "status": "",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

action_attempt_id

String (UUID)

ID of the affected action attempt.

action_type

String

Type of the action.

connected_account_id

String (UUID)

ID of the connected account associated with the action attempt, if applicable.

created_at

String (ISO 8601)

Date and time at which the event was created.

device_id

String (UUID)

ID of the device associated with the action attempt, if applicable.

event_description

String

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: action_attempt.simulate_manual_lock_via_keypad.succeeded

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

status

String

Status of the action.

workspace_id

String (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.

{
  "action_attempt_id": "00000000-0000-0000-0000-000000000000",
  "action_type": "",
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "A simulate manual lock via keypad action attempt failed.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "action_attempt.simulate_manual_lock_via_keypad.failed",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "status": "",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

action_attempt_id

String (UUID)

ID of the affected action attempt.

action_type

String

Type of the action.

connected_account_id

String (UUID)

ID of the connected account associated with the action attempt, if applicable.

created_at

String (ISO 8601)

Date and time at which the event was created.

device_id

String (UUID)

ID of the device associated with the action attempt, if applicable.

event_description

String

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

event_id

String (UUID)

ID of the event.

event_type

Enum (String)

Value: action_attempt.simulate_manual_lock_via_keypad.failed

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

status

String

Status of the action.

workspace_id

String (UUID)

ID of the workspace associated with the event.

Getting Started

Granting Access

Devices and Systems

Setup

Monitoring

Low-Level APIs

Action Attempt Events

`action_attempt.lock_door.succeeded`

`action_attempt.lock_door.failed`

`action_attempt.unlock_door.succeeded`

`action_attempt.unlock_door.failed`

`action_attempt.simulate_keypad_code_entry.succeeded`

`action_attempt.simulate_keypad_code_entry.failed`

`action_attempt.simulate_manual_lock_via_keypad.succeeded`

`action_attempt.simulate_manual_lock_via_keypad.failed`

​action_attempt.lock_door.succeeded

​action_attempt.lock_door.failed

​action_attempt.unlock_door.succeeded

​action_attempt.unlock_door.failed

​action_attempt.simulate_keypad_code_entry.succeeded

​action_attempt.simulate_keypad_code_entry.failed

​action_attempt.simulate_manual_lock_via_keypad.succeeded

​action_attempt.simulate_manual_lock_via_keypad.failed

`action_attempt.lock_door.succeeded`

`action_attempt.lock_door.failed`

`action_attempt.unlock_door.succeeded`

`action_attempt.unlock_door.failed`

`action_attempt.simulate_keypad_code_entry.succeeded`

`action_attempt.simulate_keypad_code_entry.failed`

`action_attempt.simulate_manual_lock_via_keypad.succeeded`

`action_attempt.simulate_manual_lock_via_keypad.failed`