Events

Get event details

Returns details for a specific event by ID. Supports webhook acknowledgment via callback/ack_token parameters.

GET /api/3/events/{id}

Authentication

This endpoint requires authentication:

OAuth 2.0 Recommended

Use an OAuth 2.0 access token in the Authorization header. This is the recommended authentication method for all integrations. OAuth provides automatic token expiration, granular permission scopes, detailed usage tracking, and per-integration revocation. Learn how to obtain an access token.

Header Format:

Authorization: Bearer YOUR_ACCESS_TOKEN

Required Scopes:

account.event.access.readonly

Parameters

Path Parameters

id integer
Required

Event ID

Query Parameters

callback string
Optional

Webhook callback ID for acknowledgment

ack_token string
Optional

Webhook acknowledgment token

Responses

200

Event details retrieved successfully

Response Fields

id integer required

Unique identifier for the event

eg. 123456789
event_id integer | null

Same as id (legacy field for backward compatibility)

eg. 123456789
event_code integer required

Numeric code identifying the event type. Common codes: - 10-18: Admit events (card, PIN, manual, REX, AUX, application, unlocked, Apple, Google) - 20-29: Reject events (card, out of hours, lockdown, tamper, PIN, timeout, invalid type, unauthorized, pass-back, offline) - 30: REX pressed - 31-37: Door state/alarm events - 40-42: Auto-unlock shift events - 50-63: Remote control events - 70-73: Multi-factor authentication events - 90-91: Tamper events - 100-107: Channel sync events

eg. 10
event_label string required

Human-readable description of the event

eg. John Doe admitted using card
door_controller_id integer | null

ID of the door controller (channel) where the event occurred

eg. 1340
door_controller_name string | null

Name of the door controller (channel)

eg. Front Door
channel_id integer | null

Alias for door_controller_id

eg. 1340
channel_name string | null

Alias for door_controller_name

eg. Front Door
person_id integer | null

ID of the person associated with this event (for access events)

eg. 12345
person_name string | null

Name of the person associated with this event

eg. John Doe
credentials_number string | null

Credential number used (card number, PIN, etc.)

eg. 1234567890
created_at string required

Timestamp when the event occurred

eg. 2024-01-15T14:30:00.000Z
updated_at string required

Timestamp when the event record was last updated

eg. 2024-01-15T14:30:00.000Z
401

Unauthorized - Invalid or missing authentication

Response Fields

error string
eg. unauthorized
error_description string
eg. The access token is invalid
403

Forbidden - User does not have permission

Response Fields

error string
eg. forbidden
error_description string
eg. You are not authorized to access this resource
404

Not Found - Resource does not exist or is not an admission request event

Response Fields

error string
eg. not_found
error_description string
eg. The requested resource was not found
500

Internal Server Error

Response Fields

error string
eg. internal_server_error
error_description string
eg. An unexpected error occurred

Request

curl -X GET \
  "https://api.doorflow.com/api/3/events/{id}" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Responses

Event details retrieved successfully

{
  "id": 123456789,
  "event_id": 123456789,
  "event_code": 10,
  "event_label": "John Doe admitted using card",
  "door_controller_id": 1340,
  "door_controller_name": "Front Door",
  "channel_id": 1340,
  "channel_name": "Front Door",
  "person_id": 12345,
  "person_name": "John Doe",
  "credentials_number": "1234567890",
  "created_at": "2024-01-15T14:30:00.000Z",
  "updated_at": "2024-01-15T14:30:00.000Z"
}