DoorbellChime Schema

Nest Hello 


This trait belongs to any device that supports a doorbell chime and related press events.


There are no fields available for this trait.


There are no commands available for this trait.



The doorbell has been pressed.

Chime event


  "eventId" : "b12d0707-3b64-4d8e-bed9-e2e42643b698",
  "timestamp" : "2019-01-01T00:00:01Z",
  "resourceUpdate" : {
    "name" : "enterprises/project-id/devices/device-id",
    "events" : {
      "" : {
        "eventSessionId" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...",
        "eventId" : "7sEyMSoNUU01-CSObHu6WPOkox..."
  "userId": "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi",
  "resourceGroup" : [

Chime event fields

Field Description Data Type
eventSessionId An ID given to events occurring as part of a single session of related events. May be used for consolidating events. string
Example: "CjY5Y3VKaTZwR3o4Y19YbTVfMF..."
eventId An ID associated with the event.

Use it with the GenerateImage command to download the camera image related to this event.

Example: "7sEyMSoNUU01-CSObHu6WPOkox..."


The following error code(s) may be returned in relation to this trait:

Error Message RPC Troubleshooting
Camera image is no longer available for download. DEADLINE_EXCEEDED Event images expire 30 seconds after the event is published. Make sure to download the image prior to expiration.
Event id does not belong to the camera. FAILED_PRECONDITION Use the correct eventID returned by the camera event.

See the API Error Code Reference for the full list of API error codes.