Access Method Events

`access_method.issued`

An access method was issued.

{
  "access_grant_ids": [],
  "access_grant_keys": [],
  "access_method_id": "00000000-0000-0000-0000-000000000000",
  "code": "1234",
  "created_at": "2025-01-01T00:00:00.000Z",
  "event_description": "An access method was issued.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_method.issued",
  "is_backup_code": true,
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Array of Strings (UUID)

required

IDs of the access grants associated with this access method.

Array of Strings

Keys of the access grants associated with this access method (if present).

String (UUID)

required

ID of the affected access method.

String

The actual PIN code for code access methods (only present when mode is ‘code’).

String (ISO 8601)

required

Date and time at which the event was created.

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.

String (UUID)

required

ID of the event.

Enum (String)

required

Value: access_method.issued

Boolean

Indicates whether the code is a backup code (only present when mode is ‘code’ and a backup code was used).

String (ISO 8601)

required

Date and time at which the event occurred.

String (UUID)

required

ID of the workspace associated with the event.

`access_method.revoked`

An access method was revoked.

{
  "access_grant_ids": [],
  "access_grant_keys": [],
  "access_method_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "event_description": "An access method was revoked.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_method.revoked",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Array of Strings (UUID)

required

IDs of the access grants associated with this access method.

Array of Strings

Keys of the access grants associated with this access method (if present).

String (UUID)

required

ID of the affected access method.

String (ISO 8601)

required

Date and time at which the event was created.

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.

String (UUID)

required

ID of the event.

Enum (String)

required

Value: access_method.revoked

String (ISO 8601)

required

Date and time at which the event occurred.

String (UUID)

required

ID of the workspace associated with the event.

`access_method.card_encoding_required`

An access method representing a physical card requires encoding.

{
  "access_grant_ids": [],
  "access_grant_keys": [],
  "access_method_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "event_description": "An access method representing a physical card requires encoding.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_method.card_encoding_required",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Array of Strings (UUID)

required

IDs of the access grants associated with this access method.

Array of Strings

Keys of the access grants associated with this access method (if present).

String (UUID)

required

ID of the affected access method.

String (ISO 8601)

required

Date and time at which the event was created.

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.

String (UUID)

required

ID of the event.

Enum (String)

required

Value: access_method.card_encoding_required

String (ISO 8601)

required

Date and time at which the event occurred.

String (UUID)

required

ID of the workspace associated with the event.

`access_method.deleted`

An access method was deleted.

{
  "access_grant_ids": [],
  "access_grant_keys": [],
  "access_method_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "event_description": "An access method was deleted.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_method.deleted",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Array of Strings (UUID)

required

IDs of the access grants associated with this access method.

Array of Strings

Keys of the access grants associated with this access method (if present).

String (UUID)

required

ID of the affected access method.

String (ISO 8601)

required

Date and time at which the event was created.

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.

String (UUID)

required

ID of the event.

Enum (String)

required

Value: access_method.deleted

String (ISO 8601)

required

Date and time at which the event occurred.

String (UUID)

required

ID of the workspace associated with the event.

`access_method.reissued`

An access method was reissued.

{
  "access_grant_ids": [],
  "access_grant_keys": [],
  "access_method_id": "00000000-0000-0000-0000-000000000000",
  "code": "1234",
  "created_at": "2025-01-01T00:00:00.000Z",
  "event_description": "An access method was reissued.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_method.reissued",
  "is_backup_code": true,
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Array of Strings (UUID)

required

IDs of the access grants associated with this access method.

Array of Strings

Keys of the access grants associated with this access method (if present).

String (UUID)

required

ID of the affected access method.

String

The actual PIN code for code access methods (only present when mode is ‘code’).

String (ISO 8601)

required

Date and time at which the event was created.

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.

String (UUID)

required

ID of the event.

Enum (String)

required

Value: access_method.reissued

Boolean

Indicates whether the code is a backup code (only present when mode is ‘code’ and a backup code was used).

String (ISO 8601)

required

Date and time at which the event occurred.

String (UUID)

required

ID of the workspace associated with the event.

`access_method.created`

An access method was created.

{
  "access_grant_ids": [],
  "access_grant_keys": [],
  "access_method_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "event_description": "An access method was created.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_method.created",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Array of Strings (UUID)

required

IDs of the access grants associated with this access method.

Array of Strings

Keys of the access grants associated with this access method (if present).

String (UUID)

required

ID of the affected access method.

String (ISO 8601)

required

Date and time at which the event was created.

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.

String (UUID)

required

ID of the event.

Enum (String)

required

Value: access_method.created

String (ISO 8601)

required

Date and time at which the event occurred.

String (UUID)

required

ID of the workspace associated with the event.

`access_method.delay_in_issuing`

Seam has not yet issued this access method, even though its access grant is about to begin, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and the accompanying delay_in_issuing warning clears automatically once issuance succeeds.

{
  "access_grant_ids": [],
  "access_grant_keys": [],
  "access_method_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "event_description": "Seam has not yet issued this access method, even though its access grant is about to begin, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and the accompanying `delay_in_issuing` warning clears automatically once issuance succeeds.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_method.delay_in_issuing",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Array of Strings (UUID)

required

IDs of the access grants associated with this access method.

Array of Strings

Keys of the access grants associated with this access method (if present).

String (UUID)

required

ID of the affected access method.

String (ISO 8601)

required

Date and time at which the event was created.

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.

String (UUID)

required

ID of the event.

Enum (String)

required

Value: access_method.delay_in_issuing

String (ISO 8601)

required

Date and time at which the event occurred.

String (UUID)

required

ID of the workspace associated with the event.

`access_method.failed_to_issue`

Seam was unable to issue this access method before its access grant started, so the recipient may be unable to access the space. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and the accompanying failed_to_issue error clears automatically if the access method is eventually issued.

{
  "access_grant_ids": [],
  "access_grant_keys": [],
  "access_method_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "event_description": "Seam was unable to issue this access method before its access grant started, so the recipient may be unable to access the space. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and the accompanying `failed_to_issue` error clears automatically if the access method is eventually issued.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_method.failed_to_issue",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Array of Strings (UUID)

required

IDs of the access grants associated with this access method.

Array of Strings

Keys of the access grants associated with this access method (if present).

String (UUID)

required

ID of the affected access method.

String (ISO 8601)

required

Date and time at which the event was created.

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.

String (UUID)

required

ID of the event.

Enum (String)

required

Value: access_method.failed_to_issue

String (ISO 8601)

required

Date and time at which the event occurred.

String (UUID)

required

ID of the workspace associated with the event.

Getting Started

Granting Access

Devices and Systems

Setup

Monitoring

Low-Level APIs

Access Method Events

`access_method.issued`

`access_method.revoked`

`access_method.card_encoding_required`

`access_method.deleted`

`access_method.reissued`

`access_method.created`

`access_method.delay_in_issuing`

`access_method.failed_to_issue`