Events overview

Scope

Devices and platform processes generate events. When integrating, distinguish real-time push payloads from post-hoc HTTP queries; field definitions live on the pages below.

Reader notes

Start with Using capabilities. Call device.capability.list before you use IDs on this page. See Permission codes and Capability errors.

Suggested reading order

1. Device messages — push vs pull and how they relate to alarm APIs
2. Receive device messages — callback URL, callbackFlag, and setMessageCallback (overseas callback only; no message-channel pull)
3. Event types — capability event msgType index (same set as Event types (mirror) under capabilities; the mirror links capability event samples, this catalog links event stubs)
4. Category pages linked from Event types — outputData field summaries; full capability push samples are on the matching capability event leaf (e.g. Motion detection alarm)
5. Event message format — legacy general//online-offline samples; capability push payload in Overview and common payload

In this catalog

• Event types · Event types (capabilities mirror)
• Capability usage · Capability FAQ
• By category: Device status, Binding and authorization, Detection and alarms, Doorbell and lock, Service events
• Overview and common payload
• Event message types
• Event message format

Event fields and delivery modes are maintained on the pages above.