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 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.

Webhook event types

Learn about each event type and the event trigger in the following table.
Event type Trigger
Device Data A device reports data to Milesight Development Platform.
Task Data A task is completed.
Webhook Test Click Test button to test call URI of an application.
System Messages The number of daily available Webhook push reaches the limit or the platform fails to send notifications for multiple times.