Skip to main content

Create Events

Create Events

In this guide, we will create an event for a monitorable.

Overview​

Events provide a way to track activity for a monitorable, such as a fire alarm, intruder detected, or car crash. An event can be used to track activity, or to trigger alarms that require support from an agent or first responder.

Getting Started​

Before creating events, you need:

  1. An application with the event:write scope. If you haven't created an application yet, see the Create Application API Reference to get started.
  2. An existing monitorable to create events for. See the Monitor Persons guide if you need to create one.

Once you have your application credentials, use the Set Access Token button in the navbar to configure your partner access token for making API requests.

Create an Event​

An event represents an occurrence related to a monitorable, such as an alarm, alert, or status change.

To create an event, enter your monitorable ID in the path parameter field below and send a POST request to the /monitorables/:id/events endpoint with the event details:

Path parameters

Request body

External identifier for the event. Alternatively, send the optional HTTP header External-Id when externalId is omitted or null; a string in the body takes precedence over the header.

Event type identifier

Date and time when the event was observed

Signals associated with the event

cURL command

cURLPOST
curl -X POST "/v1/monitorables/:monitorableId/events" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{
  "externalId": "ext-event-12345",
  "type": "SILENT_ALERT",
  "observedAt": "2026-10-02T18:11:59.761Z"
}'

💡 Set your access token in the navbar to auto-fill the Authorization header

Response​

Upon successful creation, you'll receive a response containing the event details:

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

Conclusion​

You've successfully created an event for a monitorable in the Hyperion platform. The event will be processed and can trigger monitoring responses based on its type and the monitorable's configuration.

Next Steps​

Now that you can create events, explore these related guides:

Learn More​

  • Events - Understanding event types and structure
  • Monitorables - Entities that events are associated with
  • Webhooks - Receiving event notifications

API Reference​