Introduction

This section gives an overview of events, alerts, and notifications for the Eagle Eye Video API Platform, and how they work together.

The /events API

The /events API is a management tool for various occurrences in your surveillance system. An event could be anything that happens on the system, such as a camera disconnection or motion detection.

Using the /events API, you can do the following:

• Retrieve a list of events.
• Filter and sort these events based on various parameters, such as the associated multi-camera, the timestamp, and the type of event.
• Create and delete events.

The /events API is crucial for keeping track of all the happenings within your surveillance setup.

The /alerts API

The /alerts API provides functionalities for managing alerts, which are generated in response to events. For example, if an event signifies that a camera has been disconnected, an alert can be generated to bring attention to this issue.

Using the /alerts API you can do the following:

• Retrieve a list of alerts
• Filter and sort alerts based on parameters such as alertType, actorId, priority, and more

Alert actions

Each alert generated by the system may contain a series of actions. Actions are defined instructions on what to do when an alert is triggered. For instance, an action might be the following: sending a notification, triggering an external system via an API call, or activating a physical response such as sounding an alarm. Alert actions allow users to automate responses to different situations.

The /notifications API

The /notifications API provides functionalities to manage the notifications that are sent out in response to these alerts. These notifications provide users with information about the alerts in a consumable format.

The /notifications allows you to do the following:

• Retrieve a list of notifications
• Filter and sort notifications
• Update the "read" status of a notifications

The process flow of events, alerts and notifications

The flow of data between these APIs can be summarized as follows:

1. An event takes place within the system.
2. This event triggers the generation of an alert, which is a reaction to the event.
3. Depending on your notification settings, a notification is sent in response to this alert.

For example:

1. Camera 1 detects motion.
2. This event triggers the "Motion detected at Camera 1" alert.
3. An email is sent with the "Motion detected at Camera 1" message.

Leveraging events, alerts and notifications

By properly utilizing the /events, /alerts and /notifications APIs in combination with the Eagle Eye AI analytics, you can optimize your surveillance system. Minimizing false alarms can help operators to focus on real alerts. Technology partners can use these APIs to build applications that offer more advanced analytic services alongside with the events and alerts generated by the system.

By integrating the events, alerts, and notifications APIs of Eagle Eye Networks into your applications, you can build a more responsive, automated, and efficient security and surveillance system.

Remember, this guide is just a starting point. There are many more functionalities and features offered by the Eagle Eye Networks API waiting for you to explore.

Learn more

Events

Event subscriptions