Allegion

Device Interaction Documentation

Device Ownership Management

Device Trait Overview

Device Events

Device Action Lifecycle

Device Reported State

Device Notifications

Synchronous Request Errors

Device Traits

AutoRelockDelaySettingsV1 Trait

BatteryV1 Trait

BeeperSettingsV1 Trait

BleCredentialSettingsV1

BleV1 Trait

ConnectivityEventSettingsV1

ConnectivityV1

CredentialsAndSchedulesV1

CredentialSettingsV1

DeviceInfoV1

DeviceResetV1

DeviceSchedulesV1

DeviceTimeV1

DoorPositionEventSettingsV1

DoorPositionV1

ExtendedAutoRelockDelaySettingsV1 Trait

FirmwareV1

ForcedEntryV1

HolidaySchedulesV1

LockEventSettingsV1

LockV1 Trait

NoTourV1 Trait

PowerSourceV1

ReaderSettingsV1

TimeZoneSettingsV1

WifiSettingsV1

Theneo Demo TechCrunch

Yonomi Interop

Bearer Token

Installation ID

Production

Sandbox

Defining CredentialsAndSchedules data objects

Defining DeviceSchedules data objects

Defining HolidaySchedules data objects

<ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><a href="6793cd550e2942240f89cbf4/6793bba56be1a8dc641034b6/67d9beaa7f3aeac98e059064" target="">AutoRelockDelaySettingsV1</a></div></li><li class="slate-li " ><div style="position:relative"><a href="6793cd550e2942240f89cbf4/6793bba56be1a8dc641034b6/67fff4552b2e97eb63e56c95" target="">BatteryV1</a></div></li><li class="slate-li " ><div style="position:relative"><a href="6793cd550e2942240f89cbf4/6793bba56be1a8dc641034b6/67ffffc2b0f423215b47fb51" target="">BeeperSettingsV1</a></div></li><li class="slate-li " ><div style="position:relative"><a href="6793cd550e2942240f89cbf4/6793bba56be1a8dc641034b6/680702a106a4707e75c66bd8" target="">BleCredentialSettingsV1</a></div></li><li class="slate-li " ><div style="position:relative"><a href="6793cd550e2942240f89cbf4/6793bba56be1a8dc641034b6/6800037091eb0ee014d6cb08" target="">BleV1</a></div></li><li class="slate-li " ><div style="position:relative"><a href="6793cd550e2942240f89cbf4/6793bba56be1a8dc641034b6/680717c57c65f18d881a729e" target="">ConnectivityEventSettingsV1</a></div></li><li class="slate-li " ><div style="position:relative"><a href="6793cd550e2942240f89cbf4/6793bba56be1a8dc641034b6/6809368ab39a45c73b69d607" target="">ConnectivityV1</a></div></li><li class="slate-li " ><div style="position:relative"><a href="6793cd550e2942240f89cbf4/6793bba56be1a8dc641034b6/68097184c1bcc504ec18f232" target="">CredentialsAndSchedulesV1</a></div></li><li class="slate-li " ><div style="position:relative"><a href="6793cd550e2942240f89cbf4/6793bba56be1a8dc641034b6/6807c96ae9b2caa5f7e283aa" target="">CredentialsSettingsV1</a></div></li><li class="slate-li " ><div style="position:relative"><a href="6793cd550e2942240f89cbf4/6793bba56be1a8dc641034b6/6807105b7c65f18d881a22fd" target="">DeviceInfoV1</a></div></li><li class="slate-li " ><div style="position:relative"><a href="6793cd550e2942240f89cbf4/6793bba56be1a8dc641034b6/68096541c1bcc504ec184775" target="">DeviceResetV1</a></div></li><li class="slate-li " ><div style="position:relative"><a href="6793cd550e2942240f89cbf4/6793bba56be1a8dc641034b6/6809b873f9d549046a3fb079" target="">DeviceSchedulesV1</a></div></li><li class="slate-li " ><div style="position:relative"><a href="6793cd550e2942240f89cbf4/6793bba56be1a8dc641034b6/680960fbd04d88e84ceacd6f" target="">DeviceTimeV1</a></div></li><li class="slate-li " ><div style="position:relative"><a href="6793cd550e2942240f89cbf4/6793bba56be1a8dc641034b6/680828ad25be1a458adf8ec6" target="">DoorPositionEventSettingsV1</a></div></li><li class="slate-li " ><div style="position:relative"><a href="6793cd550e2942240f89cbf4/6793bba56be1a8dc641034b6/68096737f9d549046a3d9c5a" target="">DoorPositionV1</a></div></li><li class="slate-li " ><div style="position:relative"><a href="6793cd550e2942240f89cbf4/6793bba56be1a8dc641034b6/67ffe72891eb0ee014d409a5" target="">ExtendedAutoRelockDelaySettingsV1</a></div></li><li class="slate-li " ><div style="position:relative"><a href="6793cd550e2942240f89cbf4/6793bba56be1a8dc641034b6/68070a774ad5e147572e671f" target="">FirmwareV1</a></div></li><li class="slate-li " ><div style="position:relative"><a href="6793cd550e2942240f89cbf4/6793bba56be1a8dc641034b6/68096324f9d549046a3cd8e3" target="">ForcedEntryV1</a></div></li><li class="slate-li " ><div style="position:relative"><a href="6793cd550e2942240f89cbf4/6793bba56be1a8dc641034b6/6809be47b39a45c73b6d9115" target="">HolidaySchedulesV1</a></div></li><li class="slate-li " ><div style="position:relative"><a href="6793cd550e2942240f89cbf4/6793bba56be1a8dc641034b6/6808339925be1a458adfa99b" target="">LockEventSettingsV1</a></div></li><li class="slate-li " ><div style="position:relative"><a href="6793cd550e2942240f89cbf4/6793bba56be1a8dc641034b6/67d9b3db7f3aeac98e01f6bc" target="">LockV1</a></div></li><li class="slate-li " ><div style="position:relative"><a href="6793bba56be1a8dc641034b6/69b03fad69c4e33fe71b48e8" target="">NoTourV1</a></div></li><li class="slate-li " ><div style="position:relative"><a href="6793cd550e2942240f89cbf4/6793bba56be1a8dc641034b6/68096a92b39a45c73b6bdd30" target="">PowerSourceV1</a></div></li><li class="slate-li " ><div style="position:relative"><a href="6793cd550e2942240f89cbf4/6793bba56be1a8dc641034b6/68083d57d4bd101ad321fb18" target="">ReaderSettingsV1</a></div></li><li class="slate-li " ><div style="position:relative"><a href="6793cd550e2942240f89cbf4/6793bba56be1a8dc641034b6/6808415ee9b2caa5f7ecd5d3" target="">TimeZoneSettingsV1</a></div></li><li class="slate-li " ><div style="position:relative"><a href="6793cd550e2942240f89cbf4/6793bba56be1a8dc641034b6/680844e625be1a458adfd330" target="">WifiSettingsV1</a></div></li></ul><p class="slate-p " ></p><p class="slate-p " ></p>

<p class="slate-p " ><em class="slate-italic">Informs if there was a factory-default reset process initiated, successfully completed, or failed on the device.</em></p><div class="slate-code_line"></div><p class="slate-p " ><strong class="slate-bold">Trait Type:</strong> Standard</p><p class="slate-p " ></p><p class="slate-p " ><h1 class="slate-h1 " >Notification Events</h1><p class="slate-p " ><em class="slate-italic">Note: See</em> <a href="6793bb72263ee370726aa002/6793be2213abf2089cf87ec4/6793be92263ee370726abd1b" target="">Overview: Device Notifications</a> <em class="slate-italic">for more information on notfication event flows.</em></p></p><p class="slate-p " ></p><h2 class="slate-h2 " >warningDeviceReset</h2><p class="slate-p " ><em class="slate-italic">Informs if there was a factory-default reset process initiated, successfully completed, or failed on the device.</em></p><h3 class="slate-h3 " >Details Fields</h3><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div><div style="width:100px;">Description</div><div style="width:100px;">Title</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Field Name</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Description</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Data Type</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >deviceResetStatus</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Status of device&apos;s factory-default reset process</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >INITIATED, FAILED, COMPLETED</p></td></div></tr></tbody></table></div><h3 class="slate-h3 " >Event Example</h3><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{</div><div class="slate-code_line">    &quot;eventType&quot;: &quot;DEVICE_NOTIFICATION_REPORTED&quot;,</div><div class="slate-code_line">    &quot;notifications&quot;: [</div><div class="slate-code_line">        {</div><div class="slate-code_line">            &quot;category&quot;: &quot;notification&quot;,</div><div class="slate-code_line">            &quot;notificationName&quot;: &quot;warningDeviceReset&quot;,</div><div class="slate-code_line">            &quot;notificationType&quot;: &quot;WARNING&quot;,</div><div class="slate-code_line">            &quot;type&quot;: &quot;notification reported&quot;,</div><div class="slate-code_line">            &quot;createdAt&quot;: &quot;2024-12-20T14:49:55.000Z&quot;,</div><div class="slate-code_line">            &quot;sampledAt&quot;: &quot;2024-12-20T14:49:39.663Z&quot;,</div><div class="slate-code_line">            &quot;installationId&quot;: &quot;819cd607-aede-482e-9aa0-8b65d420e300&quot;,</div><div class="slate-code_line">            &quot;deviceId&quot;: &quot;9a8f6104-6c50-476e-90ee-16b9a2dafc8d&quot;,</div><div class="slate-code_line">            &quot;traitName&quot;: &quot;DeviceResetV1&quot;,</div><div class="slate-code_line">            &quot;message&quot;: &quot;Device reset initiated&quot;,</div><div class="slate-code_line">            &quot;id&quot;: &quot;92197db2-63a4-4832-9a20-59dd188b6504&quot;,</div><div class="slate-code_line">            &quot;details&quot;: {</div><div class="slate-code_line">                &quot;deviceResetStatus&quot;: &quot;INITIATED&quot;</div><div class="slate-code_line">            }</div><div class="slate-code_line">        }</div><div class="slate-code_line">    ]</div><div class="slate-code_line">}</div></code></pre></div><p class="slate-p " ></p>

Informs if there was a factory-default reset process initiated, successfully completed, or failed on the device.

for more information on notfication event flows.

Title

Description

    "eventType": "DEVICE_NOTIFICATION_REPORTED",

            "notificationName": "warningDeviceReset",

            "notificationType": "WARNING",

            "type": "notification reported",

            "createdAt": "2024-12-20T14:49:55.000Z",

            "sampledAt": "2024-12-20T14:49:39.663Z",

            "installationId": "819cd607-aede-482e-9aa0-8b65d420e300",

            "deviceId": "9a8f6104-6c50-476e-90ee-16b9a2dafc8d",

            "traitName": "DeviceResetV1",

            "message": "Device reset initiated",

            "id": "92197db2-63a4-4832-9a20-59dd188b6504",

                "deviceResetStatus": "INITIATED"

Sections

DeviceResetV1

Notification Events

warningDeviceReset

Details Fields

Event Example

What made this section unhelpful for you?

On this page

Field Name	Description	Data Type
deviceResetStatus	Status of device's factory-default reset process	INITIATED, FAILED, COMPLETED