Access Grant Events

`access_grant.created`

An Access Grant was created.

{
  "access_grant_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "event_description": "An Access Grant was created.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_grant.created",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

String (UUID)

required

ID of the affected Access Grant.

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_grant.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_grant.deleted`

An Access Grant was deleted.

{
  "access_grant_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "event_description": "An Access Grant was deleted.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_grant.deleted",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

String (UUID)

required

ID of the affected Access Grant.

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_grant.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_grant.access_granted_to_all_doors`

All access requested for an Access Grant was successfully granted.

{
  "access_grant_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "event_description": "All access requested for an Access Grant was successfully granted.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_grant.access_granted_to_all_doors",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

String (UUID)

required

ID of the affected Access Grant.

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_grant.access_granted_to_all_doors

String (ISO 8601)

required

Date and time at which the event occurred.

String (UUID)

required

ID of the workspace associated with the event.

`access_grant.access_granted_to_door`

Access requested as part of an Access Grant to a particular door was successfully granted.

{
  "access_grant_id": "00000000-0000-0000-0000-000000000000",
  "acs_entrance_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "event_description": "Access requested as part of an Access Grant to a particular door was successfully granted.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_grant.access_granted_to_door",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

String (UUID)

required

ID of the affected Access Grant.

String (UUID)

required

ID of the affected entrance.

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_grant.access_granted_to_door

String (ISO 8601)

required

Date and time at which the event occurred.

String (UUID)

required

ID of the workspace associated with the event.

`access_grant.access_to_door_lost`

Access to a particular door that was requested as part of an Access Grant was lost.

{
  "access_grant_id": "00000000-0000-0000-0000-000000000000",
  "acs_entrance_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "event_description": "Access to a particular door that was requested as part of an Access Grant was lost.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_grant.access_to_door_lost",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

String (UUID)

required

ID of the affected Access Grant.

String (UUID)

required

ID of the affected entrance.

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_grant.access_to_door_lost

String (ISO 8601)

required

Date and time at which the event occurred.

String (UUID)

required

ID of the workspace associated with the event.

`access_grant.access_times_changed`

An Access Grant’s start or end time was changed.

{
  "access_grant_id": "00000000-0000-0000-0000-000000000000",
  "access_grant_key": "",
  "created_at": "2025-01-01T00:00:00.000Z",
  "ends_at": "2025-01-01T00:00:00.000Z",
  "event_description": "An Access Grant's start or end time was changed.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_grant.access_times_changed",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "starts_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

String (UUID)

required

ID of the affected Access Grant.

String

Key of the affected Access Grant (if present).

String (ISO 8601)

required

Date and time at which the event was created.

String

The new end time for the access grant.

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_grant.access_times_changed

String (ISO 8601)

required

Date and time at which the event occurred.

String

The new start time for the access grant.

String (UUID)

required

ID of the workspace associated with the event.

`access_grant.could_not_create_requested_access_methods`

One or more requested access methods could not be created for an Access Grant.

{
  "access_grant_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "error_message": "",
  "event_description": "One or more requested access methods could not be created for an Access Grant.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "access_grant.could_not_create_requested_access_methods",
  "missing_device_ids": [],
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

String (UUID)

required

ID of the affected Access Grant.

String (ISO 8601)

required

Date and time at which the event was created.

String

required

Description of why the access methods could not be 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_grant.could_not_create_requested_access_methods

Array of Strings (UUID)

IDs of the devices that did not receive a requested access method. Use these to identify which specific devices failed without having to fetch the Access Grant.

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 Grant Events

`access_grant.created`

`access_grant.deleted`

`access_grant.access_granted_to_all_doors`

`access_grant.access_granted_to_door`

`access_grant.access_to_door_lost`

`access_grant.access_times_changed`

`access_grant.could_not_create_requested_access_methods`