What are Events?

Events are occurrences that happen to a monitorable that may require a response such as an alarm. An event represents an activity, alarm, or incident such as a fire alarm activation, intrusion detection, medical emergency, or vehicle accident.

Events are the primary mechanism for triggering monitoring responses in the Hyperion platform. When an event is created, it can notify monitoring agents, trigger webhooks, and initiate response workflows based on the event type and communication preferences.

How are events structured?

Each event contains information about what occurred and when it was created. Event type, observed time, and optional signals are set when creating an event. In API responses, those fields appear at the root when you have the event:data:read scope; otherwise only identifiers and timestamps are returned.

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "partnerId": "550e8400-e29b-41d4-a716-446655440001",
  "monitorableId": "550e8400-e29b-41d4-a716-446655440002",
  "externalId": "ext-event-12345",
  "systemStatus": "ACTIVE",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Event Fields

Field	Description
id	Unique identifier assigned by Hyperion
partnerId	ID of the partner organization that owns the event
monitorableId	ID of the monitorable this event is associated with
externalId	Optional external identifier for the event in your system
systemStatus	The monitorable's system status at the time the event was created (ACTIVE, FAMILIARIZATION, CUSTOMER_TEST)
createdAt	Timestamp when the event was created in Hyperion
updatedAt	Timestamp when the event was last updated

Event Types

Events are categorized with a single type (e.g., SILENT_ALERT, INTRUSION, PANIC). Hyperion maintains a shared catalog of event types. Contact your Hyperion representative if you need additional types added to the catalog.

Example types

Type	Description
SILENT_ALERT	Alarm triggered without siren
INTRUSION	Intrusion detected
PANIC	Panic or duress button
FIRE_ALARM	Fire or smoke alarm

Communication preferences are configured on monitorable contacts. Each contact specifies a communicationMode (VOICE, VIDEO, SMS, or IN_APP_CHAT) that determines how monitoring agents reach them when responding to events.

Use Cases

Fire Alarm Detection

When a fire alarm is triggered at a monitored premises, create an event to notify monitoring agents:

{
  "externalId": "alarm-panel-zone-3",
  "type": "FIRE_ALARM",
  "observedAt": "2024-01-15T10:30:00Z"
}

Intrusion Alert

When motion sensors or door contacts detect unauthorized entry:

{
  "externalId": "sensor-front-door",
  "type": "INTRUSION",
  "observedAt": "2024-01-15T22:15:00Z"
}

Medical Emergency

When a person activates a medical panic button:

{
  "externalId": "pendant-user-12345",
  "type": "PANIC",
  "observedAt": "2024-01-15T14:30:00Z"
}

Vehicle Accident

When a vehicle's crash sensors detect an impact:

{
  "externalId": "vehicle-gps-event-789",
  "type": "INTRUSION",
  "observedAt": "2024-01-15T08:45:00Z"
}

Receiving Event Notifications

To receive real-time notifications when events are created or updated, configure webhooks to subscribe to event notifications. This allows you to integrate with your own systems and trigger automated workflows.

Related Resources

Guides

• Create Events - Step-by-step guide to create events for monitorables

API Reference

• Create Event - Create a new event
• Get Event - Retrieve event details
• List Events - List all events
• List Events by Monitorable - Get events for a specific monitorable

Related Concepts

• Monitorables - Entities that events are associated with
• Webhooks - Receive real-time event notifications