Access Code Events

`access_code.created`

An access code was created.

{
  "access_code_id": "00000000-0000-0000-0000-000000000000",
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "An [access code](/low-level-apis/smart-locks/access-codes) was created.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_code.created",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

access_code_id

String (UUID)

ID of the affected access code.

connected_account_custom_metadata

Object

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id

String (UUID)

ID of the connected account associated with the affected access code.

created_at

String (ISO 8601)

Date and time at which the event was created.

device_custom_metadata

Object

Custom metadata of the device, present when device_id is provided.

device_id

String (UUID)

ID of the device associated with the affected access code.

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: access_code.created

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`access_code.changed`

An access code was changed.

{
  "access_code_id": "00000000-0000-0000-0000-000000000000",
  "change_reason": "",
  "changed_properties": [],
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "An [access code](/low-level-apis/smart-locks/access-codes) was changed.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_code.changed",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

access_code_id

String (UUID)

ID of the affected access code.

change_reason

String

Human-readable reason for the change (e.g. ongoing code auto-renewed).

changed_properties

Array

List of properties that changed on the access code.

connected_account_custom_metadata

Object

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id

String (UUID)

ID of the connected account associated with the affected access code.

created_at

String (ISO 8601)

Date and time at which the event was created.

device_custom_metadata

Object

Custom metadata of the device, present when device_id is provided.

device_id

String (UUID)

ID of the device associated with the affected access code.

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: access_code.changed

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`access_code.name_changed`

The name of an access code was changed on the device.

{
  "access_code_id": "00000000-0000-0000-0000-000000000000",
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "description": "",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "The name of an [access code](/low-level-apis/smart-locks/access-codes) was changed on the device.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_code.name_changed",
  "from": {
    "name": "My Access Code"
  },
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "to": {
    "name": "My Access Code"
  },
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

access_code_id

String (UUID)

ID of the affected access code.

connected_account_custom_metadata

Object

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id

String (UUID)

ID of the connected account associated with the affected access code.

created_at

String (ISO 8601)

Date and time at which the event was created.

description

String

Human-readable description of the change and its source.

device_custom_metadata

Object

Custom metadata of the device, present when device_id is provided.

device_id

String (UUID)

ID of the device associated with the affected access code.

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: access_code.name_changed

from

Object

Previous access code name configuration.

Show properties

name

String

Previous name of the access code.

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

Object

New access code name configuration.

Show properties

name

String

New name of the access code.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`access_code.code_changed`

The pin code of an access code was changed on the device.

{
  "access_code_id": "00000000-0000-0000-0000-000000000000",
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "description": "",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "The pin code of an [access code](/low-level-apis/smart-locks/access-codes) was changed on the device.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_code.code_changed",
  "from": {
    "code": "1234"
  },
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "to": {
    "code": "1234"
  },
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

access_code_id

String (UUID)

ID of the affected access code.

connected_account_custom_metadata

Object

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id

String (UUID)

ID of the connected account associated with the affected access code.

created_at

String (ISO 8601)

Date and time at which the event was created.

description

String

Human-readable description of the change and its source.

device_custom_metadata

Object

Custom metadata of the device, present when device_id is provided.

device_id

String (UUID)

ID of the device associated with the affected access code.

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: access_code.code_changed

from

Object

Previous pin code configuration.

Show properties

code

String

Previous pin code.

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

Object

New pin code configuration.

Show properties

code

String

New pin code.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`access_code.time_frame_changed`

The time frame of an access code was changed on the device.

{
  "access_code_id": "00000000-0000-0000-0000-000000000000",
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "description": "",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "The time frame of an [access code](/low-level-apis/smart-locks/access-codes) was changed on the device.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_code.time_frame_changed",
  "from": {
    "ends_at": "2025-01-01T00:00:00.000Z",
    "starts_at": "2025-01-01T00:00:00.000Z"
  },
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "to": {
    "ends_at": "2025-01-01T00:00:00.000Z",
    "starts_at": "2025-01-01T00:00:00.000Z"
  },
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

access_code_id

String (UUID)

ID of the affected access code.

connected_account_custom_metadata

Object

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id

String (UUID)

ID of the connected account associated with the affected access code.

created_at

String (ISO 8601)

Date and time at which the event was created.

description

String

Human-readable description of the change and its source.

device_custom_metadata

Object

Custom metadata of the device, present when device_id is provided.

device_id

String (UUID)

ID of the device associated with the affected access code.

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: access_code.time_frame_changed

from

Object

Previous time frame configuration.

Show properties

ends_at

String

Previous end time.

starts_at

String

Previous start time.

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

Object

New time frame configuration.

Show properties

ends_at

String

New end time.

starts_at

String

New start time.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`access_code.mutations_requested`

Mutations were requested on an access code. This event fires at request time, before the change is confirmed on the device.

{
  "access_code_id": "00000000-0000-0000-0000-000000000000",
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "Mutations were requested on an [access code](/low-level-apis/smart-locks/access-codes). This event fires at request time, before the change is confirmed on the device.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_code.mutations_requested",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "requested_mutations": [],
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

access_code_id

String (UUID)

ID of the affected access code.

connected_account_custom_metadata

Object

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id

String (UUID)

ID of the connected account associated with the affected access code.

created_at

String (ISO 8601)

Date and time at which the event was created.

device_custom_metadata

Object

Custom metadata of the device, present when device_id is provided.

device_id

String (UUID)

ID of the device associated with the affected access code.

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: access_code.mutations_requested

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

requested_mutations

Array

Array of mutations requested on the access code, each containing the mutation type and from/to values.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`access_code.scheduled_on_device`

An access code was scheduled natively on a device.

{
  "access_code_id": "00000000-0000-0000-0000-000000000000",
  "code": "1234",
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "An [access code](/low-level-apis/smart-locks/access-codes) was [scheduled natively](/low-level-apis/smart-locks/access-codes#native-scheduling) on a device.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_code.scheduled_on_device",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

access_code_id

String (UUID)

ID of the affected access code.

code

String

Code for the affected access code.

connected_account_custom_metadata

Object

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id

String (UUID)

ID of the connected account associated with the affected access code.

created_at

String (ISO 8601)

Date and time at which the event was created.

device_custom_metadata

Object

Custom metadata of the device, present when device_id is provided.

device_id

String (UUID)

ID of the device associated with the affected access code.

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: access_code.scheduled_on_device

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`access_code.set_on_device`

An access code was set on a device.

{
  "access_code_id": "00000000-0000-0000-0000-000000000000",
  "code": "1234",
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "An [access code](/low-level-apis/smart-locks/access-codes) was set on a device.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_code.set_on_device",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

access_code_id

String (UUID)

ID of the affected access code.

code

String

Code for the affected access code.

connected_account_custom_metadata

Object

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id

String (UUID)

ID of the connected account associated with the affected access code.

created_at

String (ISO 8601)

Date and time at which the event was created.

device_custom_metadata

Object

Custom metadata of the device, present when device_id is provided.

device_id

String (UUID)

ID of the device associated with the affected access code.

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: access_code.set_on_device

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`access_code.removed_from_device`

An access code was removed from a device.

{
  "access_code_id": "00000000-0000-0000-0000-000000000000",
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "An [access code](/low-level-apis/smart-locks/access-codes) was removed from a device.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_code.removed_from_device",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

access_code_id

String (UUID)

ID of the affected access code.

connected_account_custom_metadata

Object

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id

String (UUID)

ID of the connected account associated with the affected access code.

created_at

String (ISO 8601)

Date and time at which the event was created.

device_custom_metadata

Object

Custom metadata of the device, present when device_id is provided.

device_id

String (UUID)

ID of the device associated with the affected access code.

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: access_code.removed_from_device

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`access_code.delay_in_setting_on_device`

There was an unusually long delay in setting an access code on a device.

{
  "access_code_errors": [],
  "access_code_id": "00000000-0000-0000-0000-000000000000",
  "access_code_warnings": [],
  "connected_account_custom_metadata": {},
  "connected_account_errors": [],
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "connected_account_warnings": [],
  "created_at": "2025-01-01T00:00:00.000Z",
  "device_custom_metadata": {},
  "device_errors": [],
  "device_id": "00000000-0000-0000-0000-000000000000",
  "device_warnings": [],
  "event_description": "There was an unusually long delay in setting an [access code](/low-level-apis/smart-locks/access-codes) on a device.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_code.delay_in_setting_on_device",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

access_code_errors

Array

Errors associated with the access code.

access_code_id

String (UUID)

ID of the affected access code.

access_code_warnings

Array

Warnings associated with the access code.

connected_account_custom_metadata

Object

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_errors

Array

Errors associated with the connected account.

connected_account_id

String (UUID)

ID of the connected account associated with the affected access code.

connected_account_warnings

Array

Warnings associated with the connected account.

created_at

String (ISO 8601)

Date and time at which the event was created.

device_custom_metadata

Object

Custom metadata of the device, present when device_id is provided.

device_errors

Array

Errors associated with the device.

device_id

String (UUID)

ID of the device associated with the affected access code.

device_warnings

Array

Warnings associated with the device.

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: access_code.delay_in_setting_on_device

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`access_code.failed_to_set_on_device`

An access code failed to be set on a device.

{
  "access_code_errors": [],
  "access_code_id": "00000000-0000-0000-0000-000000000000",
  "access_code_warnings": [],
  "connected_account_custom_metadata": {},
  "connected_account_errors": [],
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "connected_account_warnings": [],
  "created_at": "2025-01-01T00:00:00.000Z",
  "device_custom_metadata": {},
  "device_errors": [],
  "device_id": "00000000-0000-0000-0000-000000000000",
  "device_warnings": [],
  "event_description": "An [access code](/low-level-apis/smart-locks/access-codes) failed to be set on a device.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_code.failed_to_set_on_device",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

access_code_errors

Array

Errors associated with the access code.

access_code_id

String (UUID)

ID of the affected access code.

access_code_warnings

Array

Warnings associated with the access code.

connected_account_custom_metadata

Object

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_errors

Array

Errors associated with the connected account.

connected_account_id

String (UUID)

ID of the connected account associated with the affected access code.

connected_account_warnings

Array

Warnings associated with the connected account.

created_at

String (ISO 8601)

Date and time at which the event was created.

device_custom_metadata

Object

Custom metadata of the device, present when device_id is provided.

device_errors

Array

Errors associated with the device.

device_id

String (UUID)

ID of the device associated with the affected access code.

device_warnings

Array

Warnings associated with the device.

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: access_code.failed_to_set_on_device

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`access_code.deleted`

An access code was deleted.

{
  "access_code_id": "00000000-0000-0000-0000-000000000000",
  "code": "1234",
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "An [access code](/low-level-apis/smart-locks/access-codes) was deleted.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_code.deleted",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

access_code_id

String (UUID)

ID of the affected access code.

code

String

Code for the affected access code.

connected_account_custom_metadata

Object

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id

String (UUID)

ID of the connected account associated with the affected access code.

created_at

String (ISO 8601)

Date and time at which the event was created.

device_custom_metadata

Object

Custom metadata of the device, present when device_id is provided.

device_id

String (UUID)

ID of the device associated with the affected access code.

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: access_code.deleted

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`access_code.delay_in_removing_from_device`

There was an unusually long delay in removing an access code from a device.

{
  "access_code_errors": [],
  "access_code_id": "00000000-0000-0000-0000-000000000000",
  "access_code_warnings": [],
  "connected_account_custom_metadata": {},
  "connected_account_errors": [],
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "connected_account_warnings": [],
  "created_at": "2025-01-01T00:00:00.000Z",
  "device_custom_metadata": {},
  "device_errors": [],
  "device_id": "00000000-0000-0000-0000-000000000000",
  "device_warnings": [],
  "event_description": "There was an unusually long delay in removing an [access code](/low-level-apis/smart-locks/access-codes) from a device.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_code.delay_in_removing_from_device",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

access_code_errors

Array

Errors associated with the access code.

access_code_id

String (UUID)

ID of the affected access code.

access_code_warnings

Array

Warnings associated with the access code.

connected_account_custom_metadata

Object

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_errors

Array

Errors associated with the connected account.

connected_account_id

String (UUID)

ID of the connected account associated with the affected access code.

connected_account_warnings

Array

Warnings associated with the connected account.

created_at

String (ISO 8601)

Date and time at which the event was created.

device_custom_metadata

Object

Custom metadata of the device, present when device_id is provided.

device_errors

Array

Errors associated with the device.

device_id

String (UUID)

ID of the device associated with the affected access code.

device_warnings

Array

Warnings associated with the device.

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: access_code.delay_in_removing_from_device

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`access_code.failed_to_remove_from_device`

An access code failed to be removed from a device.

{
  "access_code_errors": [],
  "access_code_id": "00000000-0000-0000-0000-000000000000",
  "access_code_warnings": [],
  "connected_account_custom_metadata": {},
  "connected_account_errors": [],
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "connected_account_warnings": [],
  "created_at": "2025-01-01T00:00:00.000Z",
  "device_custom_metadata": {},
  "device_errors": [],
  "device_id": "00000000-0000-0000-0000-000000000000",
  "device_warnings": [],
  "event_description": "An [access code](/low-level-apis/smart-locks/access-codes) failed to be removed from a device.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_code.failed_to_remove_from_device",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

access_code_errors

Array

Errors associated with the access code.

access_code_id

String (UUID)

ID of the affected access code.

access_code_warnings

Array

Warnings associated with the access code.

connected_account_custom_metadata

Object

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_errors

Array

Errors associated with the connected account.

connected_account_id

String (UUID)

ID of the connected account associated with the affected access code.

connected_account_warnings

Array

Warnings associated with the connected account.

created_at

String (ISO 8601)

Date and time at which the event was created.

device_custom_metadata

Object

Custom metadata of the device, present when device_id is provided.

device_errors

Array

Errors associated with the device.

device_id

String (UUID)

ID of the device associated with the affected access code.

device_warnings

Array

Warnings associated with the device.

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: access_code.failed_to_remove_from_device

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`access_code.modified_external_to_seam`

An access code was modified outside of Seam.

{
  "access_code_id": "00000000-0000-0000-0000-000000000000",
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "An [access code](/low-level-apis/smart-locks/access-codes) was modified outside of Seam.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_code.modified_external_to_seam",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

access_code_id

String (UUID)

ID of the affected access code.

connected_account_custom_metadata

Object

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id

String (UUID)

ID of the connected account associated with the affected access code.

created_at

String (ISO 8601)

Date and time at which the event was created.

device_custom_metadata

Object

Custom metadata of the device, present when device_id is provided.

device_id

String (UUID)

ID of the device associated with the affected access code.

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: access_code.modified_external_to_seam

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`access_code.deleted_external_to_seam`

An access code was deleted outside of Seam.

{
  "access_code_id": "00000000-0000-0000-0000-000000000000",
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "An [access code](/low-level-apis/smart-locks/access-codes) was deleted outside of Seam.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_code.deleted_external_to_seam",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

access_code_id

String (UUID)

ID of the affected access code.

connected_account_custom_metadata

Object

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id

String (UUID)

ID of the connected account associated with the affected access code.

created_at

String (ISO 8601)

Date and time at which the event was created.

device_custom_metadata

Object

Custom metadata of the device, present when device_id is provided.

device_id

String (UUID)

ID of the device associated with the affected access code.

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: access_code.deleted_external_to_seam

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

`access_code.backup_access_code_pulled`

A backup access code was pulled from the backup access code pool and set on a device.

{
  "access_code_id": "00000000-0000-0000-0000-000000000000",
  "backup_access_code_id": "",
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "A [backup access code](/low-level-apis/smart-locks/access-codes/backup-access-codes) was pulled from the backup access code pool and set on a device.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_code.backup_access_code_pulled",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

access_code_id

String (UUID)

ID of the affected access code.

backup_access_code_id

String

ID of the backup access code that was pulled from the pool.

connected_account_custom_metadata

Object

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id

String (UUID)

ID of the connected account associated with the affected access code.

created_at

String (ISO 8601)

Date and time at which the event was created.

device_custom_metadata

Object

Custom metadata of the device, present when device_id is provided.

device_id

String (UUID)

ID of the device associated with the affected access code.

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: access_code.backup_access_code_pulled

occurred_at

String (ISO 8601)

Date and time at which the event occurred.

workspace_id

String (UUID)

ID of the workspace associated with the event.

Getting Started

Granting Access

Devices and Systems

Setup

Monitoring

Low-Level APIs

Access Code Events

`access_code.created`

`access_code.changed`

`access_code.name_changed`

`access_code.code_changed`

`access_code.time_frame_changed`

`access_code.mutations_requested`

`access_code.scheduled_on_device`

`access_code.set_on_device`

`access_code.removed_from_device`

`access_code.delay_in_setting_on_device`

`access_code.failed_to_set_on_device`

`access_code.deleted`

`access_code.delay_in_removing_from_device`

`access_code.failed_to_remove_from_device`

`access_code.modified_external_to_seam`

`access_code.deleted_external_to_seam`

`access_code.backup_access_code_pulled`

​access_code.created

​access_code.changed

​access_code.name_changed

​access_code.code_changed

​access_code.time_frame_changed

​access_code.mutations_requested

​access_code.scheduled_on_device

​access_code.set_on_device

​access_code.removed_from_device

​access_code.delay_in_setting_on_device

​access_code.failed_to_set_on_device

​access_code.deleted

​access_code.delay_in_removing_from_device

​access_code.failed_to_remove_from_device

​access_code.modified_external_to_seam

​access_code.deleted_external_to_seam

​access_code.backup_access_code_pulled

`access_code.created`

`access_code.changed`

`access_code.name_changed`

`access_code.code_changed`

`access_code.time_frame_changed`

`access_code.mutations_requested`

`access_code.scheduled_on_device`

`access_code.set_on_device`

`access_code.removed_from_device`

`access_code.delay_in_setting_on_device`

`access_code.failed_to_set_on_device`

`access_code.deleted`

`access_code.delay_in_removing_from_device`

`access_code.failed_to_remove_from_device`

`access_code.modified_external_to_seam`

`access_code.deleted_external_to_seam`

`access_code.backup_access_code_pulled`