Home
API Reference
Webhook Event Notification
Events
System Messages
This topic provides the example and description of the event "SYSTEM_MESSAGES".

Release History
Introduction
Getting Started
Security Overview
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 Introduction
- Webhook Event Notification
  - 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.
  - Events
    - Device Data
      This topic provides the example and description of the event "DEVICE_DATA".
    - Task Data
      This topic provides the example and description of the event "TASK_DATA".
    - Webhook Test
      This topic provides the example and description of the event "WEBHOOK_TEST".
    - System Messages
      This topic provides the example and description of the event "SYSTEM_MESSAGES".
Device Reference
FAQ
Feedback

System Messages

This topic provides the example and description of the event "SYSTEM_MESSAGES".

Trigger condition

Milesight Development Platform will send the system messages to the Webhook URI using a POST request with a JSON payload.

Example

{
    "eventID":"7e666639-a0c7-44ba-b8a1-6f1f76312fae",    // The unique ID of this event.
    "eventCreatedTime":"1742873820",    // The time at which the event occurs.Unit: s
    "eventVersion":"1.0",
    "eventType":"SYSTEM_MESSAGES"    // The event type.
    "data":{
        "message":{    // The system message content.
            "errCode":"",
            "info":""
            }
        },
        "type":"CONFIG",   // Type of the system message. 
    }
}

Task type


Type	Description
`SYSTEM_ALERT`	The Milesight Development Platform will stop sending if it fails to send notifications to the call URI for multiple times. This message can only be checked on the Webhook Simulation page of application.
`SERVICE_NOTICE`	The Milesight Development Platform will update this message when the number of daily available Webhook push has reaches the limit.