Skip to main content

​
access_grant.created

An Access Grant was created.
Example webhook payload
{
  "access_grant_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "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"
}
​
access_grant_id
String (UUID)
ID of the affected Access Grant.
​
created_at
String (ISO 8601)
Date and time at which the event was created.
​
event_id
String (UUID)
ID of the event.
​
event_type
Enum (String)
Value: access_grant.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_grant.deleted

An Access Grant was deleted.
Example webhook payload
{
  "access_grant_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "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"
}
​
access_grant_id
String (UUID)
ID of the affected Access Grant.
​
created_at
String (ISO 8601)
Date and time at which the event was created.
​
event_id
String (UUID)
ID of the event.
​
event_type
Enum (String)
Value: access_grant.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_grant.access_granted_to_all_doors

All access requested for an Access Grant was successfully granted.
Example webhook payload
{
  "access_grant_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "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"
}
​
access_grant_id
String (UUID)
ID of the affected Access Grant.
​
created_at
String (ISO 8601)
Date and time at which the event was created.
​
event_id
String (UUID)
ID of the event.
​
event_type
Enum (String)
Value: access_grant.access_granted_to_all_doors
​
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_grant.access_granted_to_door

Access requested as part of an Access Grant to a particular door was successfully granted.
Example webhook payload
{
  "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_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"
}
​
access_grant_id
String (UUID)
ID of the affected Access Grant.
​
acs_entrance_id
String (UUID)
ID of the affected entrance.
​
created_at
String (ISO 8601)
Date and time at which the event was created.
​
event_id
String (UUID)
ID of the event.
​
event_type
Enum (String)
Value: access_grant.access_granted_to_door
​
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_grant.access_to_door_lost

Access to a particular door that was requested as part of an Access Grant was lost.
Example webhook payload
{
  "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_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"
}
​
access_grant_id
String (UUID)
ID of the affected Access Grant.
​
acs_entrance_id
String (UUID)
ID of the affected entrance.
​
created_at
String (ISO 8601)
Date and time at which the event was created.
​
event_id
String (UUID)
ID of the event.
​
event_type
Enum (String)
Value: access_grant.access_to_door_lost
​
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_grant.access_times_changed

An Access Grant’s start or end time was changed.
Example webhook payload
{
  "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_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"
}
​
access_grant_id
String (UUID)
ID of the affected Access Grant.
​
access_grant_key
String
Key of the affected Access Grant (if present).
​
created_at
String (ISO 8601)
Date and time at which the event was created.
​
ends_at
String
The new end time for the access grant.
​
event_id
String (UUID)
ID of the event.
​
event_type
Enum (String)
Value: access_grant.access_times_changed
​
occurred_at
String (ISO 8601)
Date and time at which the event occurred.
​
starts_at
String
The new start time for the access grant.
​
workspace_id
String (UUID)
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.
Example webhook payload
{
  "access_grant_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "error_message": "",
  "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"
}
​
access_grant_id
String (UUID)
ID of the affected Access Grant.
​
created_at
String (ISO 8601)
Date and time at which the event was created.
​
error_message
String
Description of why the access methods could not be created.
​
event_id
String (UUID)
ID of the event.
​
event_type
Enum (String)
Value: access_grant.could_not_create_requested_access_methods
​
missing_device_ids
Array
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.
​
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.