Home
API Reference
Introduction
API Event Notification
API Event Notification Overview
Milesight Development Platform utilizes webhook for event-driven notifications, ensuring proactive and timely delivery of notifications to integrated third-party application when devices report data to the platform. This topic provides a comprehensive overview of Milesight Development Platform webhook, including the requirements, the webhook workflow, and the supported webhook events.

Release History
Getting Started
User Guide
API Reference
- Overview
  Milesight Development Platform offers Application Programming Interfaces (APIs) that allow you to integrate the system with third-party applications. Using the Milesight Development Platform API, third-party applications can access and manage resources within Milesight Development Platform, which helps you to implement workflow automation between systems and increase customization options in your own applications.
- API Interface List
  This topic provides a summary list of Milesight Development Platform API interfaces.
- Introduction
  - API Request
  - API Event Notification
    - API Event Notification Overview
      Milesight Development Platform utilizes webhook for event-driven notifications, ensuring proactive and timely delivery of notifications to integrated third-party application when devices report data to the platform. This topic provides a comprehensive overview of Milesight Development Platform webhook, including the requirements, the webhook workflow, and the supported webhook events.
    - Set up Webhook Event Notification
      This topic describes how to set up webhook event notifications, so that third-party applications can get real-time notifications when the device reports data to Milesight Development Platform.
    - Event – DEVICE_DATA
      This topic provides the example and description of the event "DEVICE_DATA".
- Featured APIs
Device Reference
FAQ

API Event Notification Overview

Milesight Development Platform utilizes webhook for event-driven notifications, ensuring proactive and timely delivery of notifications to integrated third-party application when devices report data to the platform. This topic provides a comprehensive overview of Milesight Development Platform webhook, including the requirements, the webhook workflow, and the supported webhook events.

Requirements

The third-party application supports webhook functionality.
The third-party application MUST be able to process HTTPS request and have a valid HTTPS certificate installed.

Webhook event type

Milesight Development Platform currently supports only one event type: DEVICE_DATA.

When a device reports data to Milesight Development Platform, a HTTP callback will be triggered to push the reported data to your callback URI with a JSON payload. This payload consists of an outer event object, and an embedded data object that contains the relevant event details.

For more information, see Event – DEVICE_DATA.

Webhook workflow

The following figure shows the webhook workflow:

To receive webhook event notifications from Milesight Development Platform, you need to get a webhook URL from the third-party application, and set up a webhook on Milesight Development Platfrom.

When a device reports data to Milesight Development Platform, the system will send the reported details to the webhook URI using a POST request with a JSON payload.