From 1393394d11a719cd32307c7a4a83003f92c93ab3 Mon Sep 17 00:00:00 2001 From: dawnho Date: Thu, 2 Jul 2026 10:13:43 -0700 Subject: [PATCH 1/4] docs: point concept and event links to dedicated pages in hand-written guides MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Reviewed the generic concept/event links in the affected hand-written pages and pointed each at the right dedicated reference now that resource-specific pages exist: - Troubleshooting sentences on 4 pages linked "properties/errors/warnings" to the generic Devices/Thermostats overview (mismatched target). Re-point to the dedicated device pages: properties -> /api/devices/object, errors or warnings -> /api/devices/errors ("Device Errors and Warnings"), events -> /api/devices/events. - Re-point generic [`resource.event`](/api/events/object) links (42 across 31 pages) to the resource's dedicated events page — lock.* -> /api/locks/events, thermostat.* -> /api/thermostats/events, connected_account.* -> /api/connected_accounts/events, device.* -> /api/devices/events, noise_sensor.* -> /api/noise_sensors/noise_thresholds/events. The canonical "all event types" links on the webhooks page stay on /api/events/object. - De-duplicate repeated same-concept links: keep the first, unwrap the rest. Anchored/sub-path links are left intact. Scope is non-generated pages only. Concept-link cleanup of the auto-generated API reference is handled upstream at the source (seamapi/seam-connect#16179). --- .../capability-guides/device-and-system-capabilities.mdx | 2 +- .../noise-sensors/configure-noise-threshold-settings.mdx | 2 +- .../thermostats/configure-current-climate-settings.mdx | 4 ++-- .../activating-a-climate-preset.mdx | 2 +- .../creating-and-managing-thermostat-schedules.mdx | 2 +- mintlify-docs/capability-guides/thermostats/index.mdx | 2 +- .../setting-and-monitoring-temperature-thresholds.mdx | 2 +- .../testing-your-thermostat-app-with-simulate-endpoints.mdx | 4 ++-- ...-control-systems-connected-through-a-connect-webview.mdx | 6 +++--- .../verifying-successful-account-connection.mdx | 2 +- .../core-concepts/devices/displaying-device-health.mdx | 4 ++-- .../devices/displaying-device-power-status.mdx | 2 +- mintlify-docs/core-concepts/devices/index.mdx | 2 +- .../33-lock-devices/get-started-with-33-lock-devices.mdx | 2 +- .../4suites-locks/get-started-with-4suites-locks.mdx | 2 +- .../4suites-locks/index.mdx | 2 +- .../akiles-locks/get-started-with-akiles-locks.mdx | 2 +- .../august-locks/get-started-with-august-locks.mdx | 2 +- .../get-started-with-ecobee-thermostats.mdx | 2 +- .../get-started-with-nest-thermostats.mdx | 2 +- .../google-nest-thermostats/index.mdx | 2 +- .../get-started-with-honeywell-thermostats.mdx | 2 +- .../igloohome-locks/index.mdx | 4 ++-- .../kwikset-locks/index.mdx | 4 ++-- .../minut-sensors/get-started-with-minut-sensors.mdx | 4 ++-- .../minut-sensors/index.mdx | 4 ++-- .../get-started-with-noiseaware-sensors.mdx | 4 ++-- .../noiseaware-sensors/index.mdx | 4 ++-- .../schlage-locks/schlage-locks-setup-instructions.mdx | 2 +- .../get-started-with-sensi-thermostats.mdx | 2 +- .../get-started-with-smartthings-hubs-+-smart-locks.mdx | 2 +- .../get-started-with-smartthings-hubs-+-thermostats.mdx | 2 +- .../ttlock-locks/get-started-with-ttlock-devices.mdx | 2 +- .../ttlock-locks/index.mdx | 2 +- .../access-codes/creating-access-codes/index.mdx | 2 +- .../low-level-apis/smart-locks/access-codes/index.mdx | 2 +- .../low-level-apis/smart-locks/lock-and-unlock.mdx | 4 ++-- 37 files changed, 49 insertions(+), 49 deletions(-) diff --git a/mintlify-docs/capability-guides/device-and-system-capabilities.mdx b/mintlify-docs/capability-guides/device-and-system-capabilities.mdx index 4f0c1d608..b682e9994 100644 --- a/mintlify-docs/capability-guides/device-and-system-capabilities.mdx +++ b/mintlify-docs/capability-guides/device-and-system-capabilities.mdx @@ -21,7 +21,7 @@ All capability flags share the following behavior: - If `true`, the device has this capability, and this capability is functional on this device instance. - If `false`, the device has this capability, but the capability is not currently functional. - See the device [errors](/core-concepts/devices) and [warnings](/core-concepts/devices) for more details about the cause of this issue. You can also examine the [properties](/core-concepts/devices) of the device and [events](/api/events/object) related to the device to learn more about the cause of this issue. + See the device [errors and warnings](/api/devices/errors) for more details about the cause of this issue. You can also examine the [properties](/api/devices/object) of the device and [events](/api/devices/events) related to the device to learn more about the cause of this issue. - If not present, the device does not have this capability. diff --git a/mintlify-docs/capability-guides/noise-sensors/configure-noise-threshold-settings.mdx b/mintlify-docs/capability-guides/noise-sensors/configure-noise-threshold-settings.mdx index c7ad6fe39..b16b9dbe7 100644 --- a/mintlify-docs/capability-guides/noise-sensors/configure-noise-threshold-settings.mdx +++ b/mintlify-docs/capability-guides/noise-sensors/configure-noise-threshold-settings.mdx @@ -165,4 +165,4 @@ Once you have configured your thresholds and webhooks, you can monitor events wi } ``` -For a detailed reference of event parameters, see [Events](/api/events/object). +For a detailed reference of event parameters, see [Events](/api/noise_sensors/noise_thresholds/events). diff --git a/mintlify-docs/capability-guides/thermostats/configure-current-climate-settings.mdx b/mintlify-docs/capability-guides/thermostats/configure-current-climate-settings.mdx index 07eafa4ab..6be5c64f7 100644 --- a/mintlify-docs/capability-guides/thermostats/configure-current-climate-settings.mdx +++ b/mintlify-docs/capability-guides/thermostats/configure-current-climate-settings.mdx @@ -24,7 +24,7 @@ Note that it's important to check the capabilities of a thermostat before attemp These imperative operations return an [action attempt](../../core-concepts/action-attempts) that enables you to track the progress of the action. Poll this action attempt, until the action completes. -Further, Seam emits a [`thermostat.temperature_reached_set_point` event](/api/events/object) when the thermostat reports a temperature within 1° Celsius of the heating or cooling temperature that you requested. +Further, Seam emits a [`thermostat.temperature_reached_set_point` event](/api/thermostats/events) when the thermostat reports a temperature within 1° Celsius of the heating or cooling temperature that you requested. --- @@ -118,7 +118,7 @@ Before you attempt to set the HVAC or fan mode settings for a thermostat, be sur Use the [`/devices/get`](/api/devices/get) endpoint for a specific device to return these capability flags. Then, use an `if` statement or similar check to confirm that the relevant flag is both present and `true` before attempting to perform the imperative thermostat action. -If the relevant capability flag is `false` or not present, you can view the [properties](/capability-guides/thermostats) of the device, [errors](/core-concepts/devices) or [warnings](/core-concepts/devices) for the device, and [events](/api/events/object) related to the device to learn more about the cause of these issues. For example, you could examine `device.properties.online`. In addition, you could look for a `device.disconnected` event. +If the relevant capability flag is `false` or not present, you can view the [properties](/api/devices/object) of the device, [errors or warnings](/api/devices/errors) for the device, and [events](/api/devices/events) related to the device to learn more about the cause of these issues. For example, you could examine `device.properties.online`. In addition, you could look for a `device.disconnected` event. **Request:** diff --git a/mintlify-docs/capability-guides/thermostats/creating-and-managing-climate-presets/activating-a-climate-preset.mdx b/mintlify-docs/capability-guides/thermostats/creating-and-managing-climate-presets/activating-a-climate-preset.mdx index fdf0e3321..590aa2dab 100644 --- a/mintlify-docs/capability-guides/thermostats/creating-and-managing-climate-presets/activating-a-climate-preset.mdx +++ b/mintlify-docs/capability-guides/thermostats/creating-and-managing-climate-presets/activating-a-climate-preset.mdx @@ -7,7 +7,7 @@ In addition to [scheduling](../creating-and-managing-thermostat-schedules) clima Activating a climate preset returns an [action attempt](../../../core-concepts/action-attempts) that enables you to track the progress of the action. Poll this action attempt, until the action completes. -Further, Seam emits a [`thermostat.temperature_reached_set_point` event](/api/events/object) when the thermostat reports a temperature within 1° Celsius of the heating or cooling [set point](../understanding-thermostat-concepts/set-points) specified in the climate preset that you've activated. You can configure a [webhook](../../../developer-tools/webhooks) to watch for this event. +Further, Seam emits a [`thermostat.temperature_reached_set_point` event](/api/thermostats/events) when the thermostat reports a temperature within 1° Celsius of the heating or cooling [set point](../understanding-thermostat-concepts/set-points) specified in the climate preset that you've activated. You can configure a [webhook](../../../developer-tools/webhooks) to watch for this event. --- diff --git a/mintlify-docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.mdx b/mintlify-docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.mdx index 32b97d312..ca05ef1f7 100644 --- a/mintlify-docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.mdx +++ b/mintlify-docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.mdx @@ -102,7 +102,7 @@ In the Seam API, use the `starts_at` and `ends_at` parameters to define the time `starts_at` is required and must be unique within all the schedules for the thermostat. However, if you want to schedule a climate preset that starts immediately, set `start_at` to a time in the past. Alternately, you can [activate a climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets/activating-a-climate-preset) immediately. -After a scheduled climate preset starts, Seam emits a [`thermostat.temperature_reached_set_point` event](/api/events/object) when the thermostat reports a temperature within 1° Celsius of the heating or cooling [set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) specified in this climate preset. You can configure a [webhook](../../developer-tools/webhooks) to watch for this event. +After a scheduled climate preset starts, Seam emits a [`thermostat.temperature_reached_set_point` event](/api/thermostats/events) when the thermostat reports a temperature within 1° Celsius of the heating or cooling [set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) specified in this climate preset. You can configure a [webhook](../../developer-tools/webhooks) to watch for this event. --- diff --git a/mintlify-docs/capability-guides/thermostats/index.mdx b/mintlify-docs/capability-guides/thermostats/index.mdx index 0a1cec085..ea654500f 100644 --- a/mintlify-docs/capability-guides/thermostats/index.mdx +++ b/mintlify-docs/capability-guides/thermostats/index.mdx @@ -36,7 +36,7 @@ First, connect your users' thermostats to Seam using the [Seam Console](/core-co Retrieve and monitor your users' thermostats using the [`/thermostats/list`](/api/thermostats/list) and [`/devices/get`](/api/devices/get) endpoints. The Seam API returns robust, up-to-date information about your connected thermostats. In addition, you can use these endpoints to learn the capabilities of each thermostat. -Further, you can use the [`/thermostats/set_temperature_threshold`](/api/thermostats/set_temperature_threshold) endpoint to set upper and lower acceptable temperature bounds. If the thermostat reports a temperature outside this range, Seam emits a [`thermostat.temperature_threshold_exceeded` event](/api/events/object). +Further, you can use the [`/thermostats/set_temperature_threshold`](/api/thermostats/set_temperature_threshold) endpoint to set upper and lower acceptable temperature bounds. If the thermostat reports a temperature outside this range, Seam emits a [`thermostat.temperature_threshold_exceeded` event](/api/thermostats/events). ### Perform Remote Management diff --git a/mintlify-docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.mdx b/mintlify-docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.mdx index ed9de8712..20773a01c 100644 --- a/mintlify-docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.mdx +++ b/mintlify-docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.mdx @@ -3,7 +3,7 @@ title: 'Setting and Monitoring Temperature Thresholds' description: 'Learn how to use temperature thresholds to monitor your thermostat for potential HVAC system misuse or malfunctioning.' --- -You can configure Seam to emit a [`thermostat.temperature_threshold_exceeded` event](/api/events/object) if a thermostat reports a temperature outside a specific threshold range. This capability helps you to monitor your thermostats proactively, alerting you to potential HVAC system misuse or malfunctioning. +You can configure Seam to emit a [`thermostat.temperature_threshold_exceeded` event](/api/thermostats/events) if a thermostat reports a temperature outside a specific threshold range. This capability helps you to monitor your thermostats proactively, alerting you to potential HVAC system misuse or malfunctioning. Use the [`/thermostats/set_temperature_threshold`](/api/thermostats/set_temperature_threshold) endpoint to set upper and lower acceptable temperature bounds. Then, you can use a [webhook](../../developer-tools/webhooks) to monitor for `thermostat.temperature_threshold_exceeded` events. diff --git a/mintlify-docs/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.mdx b/mintlify-docs/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.mdx index 89765c539..46a2f1f25 100644 --- a/mintlify-docs/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.mdx +++ b/mintlify-docs/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.mdx @@ -35,7 +35,7 @@ For more information, see [Thermostat Capabilities](/capability-guides/thermosta ## Simulate Adjusting the HVAC Mode -The `/thermostats/simulate/hvac_mode_adjusted` endpoint enables you to simulate having adjusted the [HVAC mode](./understanding-thermostat-concepts/hvac-mode) for a thermostat. This simulation is helpful for testing that your app is receiving [thermostat events](/api/events/object) correctly, such as `thermostat.manually_adjusted`. +The `/thermostats/simulate/hvac_mode_adjusted` endpoint enables you to simulate having adjusted the [HVAC mode](./understanding-thermostat-concepts/hvac-mode) for a thermostat. This simulation is helpful for testing that your app is receiving [thermostat events](/api/thermostats/events) correctly, such as `thermostat.manually_adjusted`. You can simulate having set the HVAC mode to any of the following settings: @@ -210,7 +210,7 @@ void ## Simulate Reaching a Desired Temperature -The `/thermostats/simulate/temperature_reached` endpoint enables you to simulate the thermostat reaching a specified temperature. This simulation is helpful for testing that your app is receiving [thermostat events](/api/events/object) correctly, such as `thermostat.temperature_changed` and `thermostat.temperature_reached_set_point`. +The `/thermostats/simulate/temperature_reached` endpoint enables you to simulate the thermostat reaching a specified temperature. This simulation is helpful for testing that your app is receiving [thermostat events](/api/thermostats/events) correctly, such as `thermostat.temperature_changed` and `thermostat.temperature_reached_set_point`. Specify the desired temperature that you want to simulate the thermostat reaching using either of the following parameters: diff --git a/mintlify-docs/core-concepts/connect-webviews/retrieving-devices-or-access-control-systems-connected-through-a-connect-webview.mdx b/mintlify-docs/core-concepts/connect-webviews/retrieving-devices-or-access-control-systems-connected-through-a-connect-webview.mdx index 8773873e7..d93092135 100644 --- a/mintlify-docs/core-concepts/connect-webviews/retrieving-devices-or-access-control-systems-connected-through-a-connect-webview.mdx +++ b/mintlify-docs/core-concepts/connect-webviews/retrieving-devices-or-access-control-systems-connected-through-a-connect-webview.mdx @@ -3,7 +3,7 @@ title: 'Retrieving Devices or Access Control Systems Connected Through a Connect description: 'Learn how to retrieve the set of devices or ACS that your app user connected to Seam through a specific Connect Webview.' --- -When your app user completes a [Connect Webview](./) authorization flow successfully, the resulting [`connected_account.connected` event](/api/events/object) includes a `connected_account_id`. Also, once the connection is successful, the [`connect_webview` object](/api/connect_webviews/object) includes the `connected_account_id`. +When your app user completes a [Connect Webview](./) authorization flow successfully, the resulting [`connected_account.connected` event](/api/connected_accounts/events) includes a `connected_account_id`. Also, once the connection is successful, the [`connect_webview` object](/api/connect_webviews/object) includes the `connected_account_id`. The first step in controlling connected devices or a connected ACS is to retrieve the newly-connected set of devices or ACS. @@ -17,7 +17,7 @@ Use this `connected_account_id` in a [List Devices](/api/devices/list) command t If you set `wait_for_device_creation` to `false` when [creating the Connect Webview](/core-concepts/connect-webviews/embedding-a-connect-webview-in-your-app#step-1-open-a-connect-webview), you should wait for the [`connected_account.completed_first_sync` - event](/api/events/object) before retrieving the user's + event](/api/connected_accounts/events) before retrieving the user's devices. This event indicates that Seam has finished the first sync of the connected account and the devices are now available. @@ -173,7 +173,7 @@ Use this `connected_account_id` in a [List ACS Systems](/api/acs/systems/list) c If you set `wait_for_device_creation` to `false` when [creating the Connect Webview](/core-concepts/connect-webviews/embedding-a-connect-webview-in-your-app#step-1-open-a-connect-webview), you should wait for the [`connected_account.completed_first_sync` - event](/api/events/object) before retrieving the user's + event](/api/connected_accounts/events) before retrieving the user's ACS. This event indicates that Seam has finished the first sync of the connected account and the `acs_system` is now available. diff --git a/mintlify-docs/core-concepts/connect-webviews/verifying-successful-account-connection.mdx b/mintlify-docs/core-concepts/connect-webviews/verifying-successful-account-connection.mdx index 9d0ad9fc1..d057cbbaa 100644 --- a/mintlify-docs/core-concepts/connect-webviews/verifying-successful-account-connection.mdx +++ b/mintlify-docs/core-concepts/connect-webviews/verifying-successful-account-connection.mdx @@ -145,7 +145,7 @@ ConnectWebview( ## **Webhook** -When Seam successfully establishes the connection to the user's device or ACS account, Seam emits a [`connected_account.connected` event](/api/events/object). This event includes a `connect_webview_id` property. +When Seam successfully establishes the connection to the user's device or ACS account, Seam emits a [`connected_account.connected` event](/api/connected_accounts/events). This event includes a `connect_webview_id` property. To avoid polling, use a Seam webhook to monitor for a `connected_account.connected` event with a `connect_webview_id` that matches the `connect_webview_id` of the appropriate Connect Webview instance. diff --git a/mintlify-docs/core-concepts/devices/displaying-device-health.mdx b/mintlify-docs/core-concepts/devices/displaying-device-health.mdx index 7e901e4c5..e910fa277 100644 --- a/mintlify-docs/core-concepts/devices/displaying-device-health.mdx +++ b/mintlify-docs/core-concepts/devices/displaying-device-health.mdx @@ -101,7 +101,7 @@ Online: True ## Get Device Status Using Connection-Related Events -When a device connection or disconnection occurs, Seam generates a [`device.connected`](/api/events/object) or [`device.disconnected`](/api/events/object) event, respectively. You can retrieve these events using a [List Events](/api/events/list) request or through [webhooks](../../developer-tools/webhooks) and then display the corresponding status in your app. +When a device connection or disconnection occurs, Seam generates a [`device.connected`](/api/devices/events) or [`device.disconnected`](/api/devices/events) event, respectively. You can retrieve these events using a [List Events](/api/events/list) request or through [webhooks](../../developer-tools/webhooks) and then display the corresponding status in your app. To help you test your app against events—like device disconnection or @@ -114,7 +114,7 @@ When a device connection or disconnection occurs, Seam generates a [`device.conn ### Get Connection-Related Events Using a List Events Request -When issuing a [List Events](/api/events/list) request to retrieve [`device.connected`](/api/events/object) or [`device.disconnected`](/api/events/object) events for a specific device, include the following parameters: +When issuing a [List Events](/api/events/list) request to retrieve [`device.connected`](/api/devices/events) or [`device.disconnected`](/api/devices/events) events for a specific device, include the following parameters: diff --git a/mintlify-docs/core-concepts/devices/displaying-device-power-status.mdx b/mintlify-docs/core-concepts/devices/displaying-device-power-status.mdx index 909d73f8f..e6ded3723 100644 --- a/mintlify-docs/core-concepts/devices/displaying-device-power-status.mdx +++ b/mintlify-docs/core-concepts/devices/displaying-device-power-status.mdx @@ -235,7 +235,7 @@ You can retrieve these events using a [List Events](/api/events/list) request or ### Get Battery-Related Events Using a List Events Request -When issuing a [List Events](/api/events/list) request to retrieve [`device.low_battery`](/api/events/object) or [`device.battery_status_changed`](/api/events/object) events for a specific device, include the following parameters: +When issuing a [List Events](/api/events/list) request to retrieve [`device.low_battery`](/api/devices/events) or [`device.battery_status_changed`](/api/devices/events) events for a specific device, include the following parameters:
diff --git a/mintlify-docs/core-concepts/devices/index.mdx b/mintlify-docs/core-concepts/devices/index.mdx index 4c58541e3..4df0501ea 100644 --- a/mintlify-docs/core-concepts/devices/index.mdx +++ b/mintlify-docs/core-concepts/devices/index.mdx @@ -16,5 +16,5 @@ In addition, Seam provides the following three sets of device-related features: - **Actions:** Commands that you can issue to the device, such as unlock. For more information, see the [Capability Guides](../../capability-guides/device-and-system-capabilities). - **Properties:** The current state of the device, such as the locked, online, and managed statuses. For details, see [`device` Properties](/core-concepts/devices). -- **Events:** Notifications related to changes in the state of the device, such as an unlocking operation performed with an access code. For details, see [Events](/api/events/object).\ +- **Events:** Notifications related to changes in the state of the device, such as an unlocking operation performed with an access code. For details, see [Events](/api/devices/events).\ To help you test your app against events—like device disconnection or removal—that are difficult to orchestrate in a QA environment using real devices, Seam provides a suite of `simulate` endpoints that you can use in a [sandbox workspace](/core-concepts/workspaces/index#sandbox-workspaces). See [Testing Your App Against Device Disconnection and Removal](/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal). diff --git a/mintlify-docs/device-and-system-integration-guides/33-lock-devices/get-started-with-33-lock-devices.mdx b/mintlify-docs/device-and-system-integration-guides/33-lock-devices/get-started-with-33-lock-devices.mdx index eab3a29f4..86d5de66e 100644 --- a/mintlify-docs/device-and-system-integration-guides/33-lock-devices/get-started-with-33-lock-devices.mdx +++ b/mintlify-docs/device-and-system-integration-guides/33-lock-devices/get-started-with-33-lock-devices.mdx @@ -783,7 +783,7 @@ ActionAttempt( -You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/events/object). +You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events). To query the `locked` status of the device: diff --git a/mintlify-docs/device-and-system-integration-guides/4suites-locks/get-started-with-4suites-locks.mdx b/mintlify-docs/device-and-system-integration-guides/4suites-locks/get-started-with-4suites-locks.mdx index 0deb981e5..af5f5c5e5 100644 --- a/mintlify-docs/device-and-system-integration-guides/4suites-locks/get-started-with-4suites-locks.mdx +++ b/mintlify-docs/device-and-system-integration-guides/4suites-locks/get-started-with-4suites-locks.mdx @@ -766,7 +766,7 @@ ActionAttempt( -You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/events/object). +You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events). To query the `locked` status of the device: diff --git a/mintlify-docs/device-and-system-integration-guides/4suites-locks/index.mdx b/mintlify-docs/device-and-system-integration-guides/4suites-locks/index.mdx index 72c2921fc..091fef832 100644 --- a/mintlify-docs/device-and-system-integration-guides/4suites-locks/index.mdx +++ b/mintlify-docs/device-and-system-integration-guides/4suites-locks/index.mdx @@ -56,7 +56,7 @@ To create a [Connect Webview](/core-concepts/connect-webviews) that enables your To control 4SUITES devices using Seam, you must prompt owners of these devices to perform the following steps: 1. Obtain the credentials that you use to log in to your [4SUITES account](https://app.4suites.nl/auth/login). -2. Use these credentials to log in to the [Seam Connect Webview](/core-concepts/connect-webviews) to add your 4SUITES devices to Seam. +2. Use these credentials to log in to the Seam Connect Webview to add your 4SUITES devices to Seam. --- diff --git a/mintlify-docs/device-and-system-integration-guides/akiles-locks/get-started-with-akiles-locks.mdx b/mintlify-docs/device-and-system-integration-guides/akiles-locks/get-started-with-akiles-locks.mdx index e53f4ffb1..d11bdc373 100644 --- a/mintlify-docs/device-and-system-integration-guides/akiles-locks/get-started-with-akiles-locks.mdx +++ b/mintlify-docs/device-and-system-integration-guides/akiles-locks/get-started-with-akiles-locks.mdx @@ -766,7 +766,7 @@ ActionAttempt( -You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/events/object). +You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events). To query the `locked` status of the device: diff --git a/mintlify-docs/device-and-system-integration-guides/august-locks/get-started-with-august-locks.mdx b/mintlify-docs/device-and-system-integration-guides/august-locks/get-started-with-august-locks.mdx index 8c864ce87..2fb5167f5 100644 --- a/mintlify-docs/device-and-system-integration-guides/august-locks/get-started-with-august-locks.mdx +++ b/mintlify-docs/device-and-system-integration-guides/august-locks/get-started-with-august-locks.mdx @@ -798,7 +798,7 @@ ActionAttempt( -You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/events/object). +You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events). To query the `locked` status of the device: diff --git a/mintlify-docs/device-and-system-integration-guides/ecobee-thermostats/get-started-with-ecobee-thermostats.mdx b/mintlify-docs/device-and-system-integration-guides/ecobee-thermostats/get-started-with-ecobee-thermostats.mdx index f0bd3a37e..00dc76e04 100644 --- a/mintlify-docs/device-and-system-integration-guides/ecobee-thermostats/get-started-with-ecobee-thermostats.mdx +++ b/mintlify-docs/device-and-system-integration-guides/ecobee-thermostats/get-started-with-ecobee-thermostats.mdx @@ -840,7 +840,7 @@ ActionAttempt( -You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/events/object). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. +You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/thermostats/events). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. To query `properties.current_climate_setting.hvac_mode_setting` for the device: diff --git a/mintlify-docs/device-and-system-integration-guides/google-nest-thermostats/get-started-with-nest-thermostats.mdx b/mintlify-docs/device-and-system-integration-guides/google-nest-thermostats/get-started-with-nest-thermostats.mdx index 21d6cedea..99b662f46 100644 --- a/mintlify-docs/device-and-system-integration-guides/google-nest-thermostats/get-started-with-nest-thermostats.mdx +++ b/mintlify-docs/device-and-system-integration-guides/google-nest-thermostats/get-started-with-nest-thermostats.mdx @@ -833,7 +833,7 @@ ActionAttempt( -You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/events/object). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. +You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/thermostats/events). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. To query `properties.current_climate_setting.hvac_mode_setting` for the device: diff --git a/mintlify-docs/device-and-system-integration-guides/google-nest-thermostats/index.mdx b/mintlify-docs/device-and-system-integration-guides/google-nest-thermostats/index.mdx index dc6b59f37..b2df980b6 100644 --- a/mintlify-docs/device-and-system-integration-guides/google-nest-thermostats/index.mdx +++ b/mintlify-docs/device-and-system-integration-guides/google-nest-thermostats/index.mdx @@ -68,7 +68,7 @@ Google Nest thermostats support an eco HVAC mode. To set a Google Nest thermosta ## Troubleshooting -If you have not yet [obtained Google Commercial Development](/device-and-system-integration-guides/google-nest-thermostats/obtain-google-nest-device-access-and-commercial-development), and your end user attempts to connect a Google Nest thermostat to Seam using a [Connect Webview](/core-concepts/connect-webviews), the Connect Webview displays the following error: +If you have not yet [obtained Google Commercial Development](/device-and-system-integration-guides/google-nest-thermostats/obtain-google-nest-device-access-and-commercial-development), and your end user attempts to connect a Google Nest thermostat to Seam using a Connect Webview, the Connect Webview displays the following error: > No access to partner > diff --git a/mintlify-docs/device-and-system-integration-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.mdx b/mintlify-docs/device-and-system-integration-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.mdx index 328b2a128..ef7caf6c4 100644 --- a/mintlify-docs/device-and-system-integration-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.mdx +++ b/mintlify-docs/device-and-system-integration-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.mdx @@ -831,7 +831,7 @@ ActionAttempt( -You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/events/object). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. +You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/thermostats/events). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. To query `properties.current_climate_setting.hvac_mode_setting` for the device: diff --git a/mintlify-docs/device-and-system-integration-guides/igloohome-locks/index.mdx b/mintlify-docs/device-and-system-integration-guides/igloohome-locks/index.mdx index c6fcf778a..aabaf4b5f 100644 --- a/mintlify-docs/device-and-system-integration-guides/igloohome-locks/index.mdx +++ b/mintlify-docs/device-and-system-integration-guides/igloohome-locks/index.mdx @@ -80,11 +80,11 @@ Seam supports the following events and event property values for igloohome devic ### igloohome Auto-Relock -igloohome devices have an auto-relock feature that automatically locks the device after a configurable period of time, for example, 30 seconds. The Seam API reports these auto-relock occurrences by emitting a [`lock.locked` event](/api/events/object) with `automatic` as the value for the `method` property. +igloohome devices have an auto-relock feature that automatically locks the device after a configurable period of time, for example, 30 seconds. The Seam API reports these auto-relock occurrences by emitting a [`lock.locked` event](/api/locks/events) with `automatic` as the value for the `method` property. ### igloohome Access Denied Event -Each time an igloohome device detects an invalid attempt of entry, Seam emits a [`lock.access_denied` event](/api/events/object). Invalid entry attempts include entering the wrong PIN, exceeding the PIN length, and using an invalid key card. The igloohome lock also flashes red to indicate an invalid attempt. If too many invalid attempts occur, igloohome locks produce a Keypad Security Lockout alarm, accompanied by light and sound indicators. For more information, see the igloohome support articles on [keypad security](https://support.igloohome.co/support/solutions/articles/35000169627-keypad-security-lockout-activated-and-deactivated) and [incorrect PINs](https://support.igloohome.co/support/solutions/articles/35000169625-incorrect-pin). +Each time an igloohome device detects an invalid attempt of entry, Seam emits a [`lock.access_denied` event](/api/locks/events). Invalid entry attempts include entering the wrong PIN, exceeding the PIN length, and using an invalid key card. The igloohome lock also flashes red to indicate an invalid attempt. If too many invalid attempts occur, igloohome locks produce a Keypad Security Lockout alarm, accompanied by light and sound indicators. For more information, see the igloohome support articles on [keypad security](https://support.igloohome.co/support/solutions/articles/35000169627-keypad-security-lockout-activated-and-deactivated) and [incorrect PINs](https://support.igloohome.co/support/solutions/articles/35000169625-incorrect-pin). --- diff --git a/mintlify-docs/device-and-system-integration-guides/kwikset-locks/index.mdx b/mintlify-docs/device-and-system-integration-guides/kwikset-locks/index.mdx index 5b7b4999a..a314b623e 100644 --- a/mintlify-docs/device-and-system-integration-guides/kwikset-locks/index.mdx +++ b/mintlify-docs/device-and-system-integration-guides/kwikset-locks/index.mdx @@ -89,11 +89,11 @@ Seam supports the following events and event property values for Kwikset devices ### Kwikset Auto-Lock -Kwikset devices have an auto-lock feature that automatically locks the device after a configurable period of time, for example, 30 seconds. The Seam API reports these auto-lock occurrences by emitting a [`lock.locked` event](/api/events/object) with `automatic` as the value for the `method` property. +Kwikset devices have an auto-lock feature that automatically locks the device after a configurable period of time, for example, 30 seconds. The Seam API reports these auto-lock occurrences by emitting a [`lock.locked` event](/api/locks/events) with `automatic` as the value for the `method` property. ### Kwikset Access Denied Event -The Seam API emits a [`lock.access_denied` event](/api/events/object) when an incorrect access code is entered three times in a row on a Kwikset device. The Kwikset device also emits warning beeps for approximately 15 seconds, and the keypad is locked during this time. The keypad remains locked for one minute after the warning beeps end. +The Seam API emits a [`lock.access_denied` event](/api/locks/events) when an incorrect access code is entered three times in a row on a Kwikset device. The Kwikset device also emits warning beeps for approximately 15 seconds, and the keypad is locked during this time. The keypad remains locked for one minute after the warning beeps end. --- diff --git a/mintlify-docs/device-and-system-integration-guides/minut-sensors/get-started-with-minut-sensors.mdx b/mintlify-docs/device-and-system-integration-guides/minut-sensors/get-started-with-minut-sensors.mdx index 5e3ee6c6d..fcc1a9337 100644 --- a/mintlify-docs/device-and-system-integration-guides/minut-sensors/get-started-with-minut-sensors.mdx +++ b/mintlify-docs/device-and-system-integration-guides/minut-sensors/get-started-with-minut-sensors.mdx @@ -142,7 +142,7 @@ Navigate to the URL returned by the Webview object. Since you are using a sandbo ### Get the New Webview -After you complete the login above, you'll get an event for [`connected_account.created`](/api/events/object)if you set up a [webhook handler](/developer-tools/webhooks). Otherwise you can just poll for the webview until it's status changes, as shown below: +After you complete the login above, you'll get an event for [`connected_account.created`](/api/connected_accounts/events)if you set up a [webhook handler](/developer-tools/webhooks). Otherwise you can just poll for the webview until it's status changes, as shown below: @@ -558,7 +558,7 @@ echo json_encode($device[0]); Minut users can define noise thresholds at which noise alerts are sent. -You'll get an event for `noise_threshold.noise_threshold_triggered` when you set up a [webhook handler](/developer-tools/webhooks). You can also [poll for events](/api/events/list). +You'll get an event for `noise_threshold.noise_threshold_triggered` when you set up a webhook handler. You can also [poll for events](/api/events/list). Minut has a builtin threshold that can be triggered multiple times. Each Minut notice will trigger a `noise_threshold_triggered` event with the `minut_metadata.event_name` containing the Minut event name, which can be any of the following: diff --git a/mintlify-docs/device-and-system-integration-guides/minut-sensors/index.mdx b/mintlify-docs/device-and-system-integration-guides/minut-sensors/index.mdx index 2e560eaed..629354535 100644 --- a/mintlify-docs/device-and-system-integration-guides/minut-sensors/index.mdx +++ b/mintlify-docs/device-and-system-integration-guides/minut-sensors/index.mdx @@ -42,8 +42,8 @@ We support the following features: - [Configuring noise threshold settings](/capability-guides/noise-sensors/configure-noise-threshold-settings)\ You can configure a maximum of two noise thresholds per Minut sensor. The first threshold is required and represents the regular threshold for the whole day. The second threshold is optional and represents the threshold for the quiet hours timeframe. -- [Receiving noise sensor events when noise events occur](/api/events/object)\ - For more information, see the [`noise_sensor.noise_threshold_triggered` event](/api/events/object). +- [Receiving noise sensor events when noise events occur](/api/noise_sensors/noise_thresholds/events)\ + For more information, see the [`noise_sensor.noise_threshold_triggered` event](/api/noise_sensors/noise_thresholds/events). --- diff --git a/mintlify-docs/device-and-system-integration-guides/noiseaware-sensors/get-started-with-noiseaware-sensors.mdx b/mintlify-docs/device-and-system-integration-guides/noiseaware-sensors/get-started-with-noiseaware-sensors.mdx index 7fa20cbf3..d2b8bb0c2 100644 --- a/mintlify-docs/device-and-system-integration-guides/noiseaware-sensors/get-started-with-noiseaware-sensors.mdx +++ b/mintlify-docs/device-and-system-integration-guides/noiseaware-sensors/get-started-with-noiseaware-sensors.mdx @@ -152,7 +152,7 @@ Navigate to the URL returned by the Webview object. Since you are using a sandbo ### Get the New Webview -After you complete the login above, you'll get an event for [`connected_account.created`](/api/events/object)if you set up a [webhook handler](/developer-tools/webhooks). Otherwise you can just poll for the webview until it's status changes, as shown below: +After you complete the login above, you'll get an event for [`connected_account.created`](/api/connected_accounts/events)if you set up a [webhook handler](/developer-tools/webhooks). Otherwise you can just poll for the webview until it's status changes, as shown below: @@ -342,7 +342,7 @@ echo json_encode($device[0]); NoiseAware users can define noise thresholds at which noise alerts are sent. -You'll get an event for `noise_threshold.noise_threshold_triggered` when you set up a [webhook handler](/developer-tools/webhooks). You can also [poll for events](/api/events/list). +You'll get an event for `noise_threshold.noise_threshold_triggered` when you set up a webhook handler. You can also [poll for events](/api/events/list). NoiseAware has three distinct noise alerts: `newNoise`, `continuedNoise`, and diff --git a/mintlify-docs/device-and-system-integration-guides/noiseaware-sensors/index.mdx b/mintlify-docs/device-and-system-integration-guides/noiseaware-sensors/index.mdx index 4f96eda84..3c00e4403 100644 --- a/mintlify-docs/device-and-system-integration-guides/noiseaware-sensors/index.mdx +++ b/mintlify-docs/device-and-system-integration-guides/noiseaware-sensors/index.mdx @@ -42,8 +42,8 @@ We support the following features: - [Configuring noise threshold settings](/capability-guides/noise-sensors/configure-noise-threshold-settings)\ You can configure a maximum of one noise threshold per hour per Noiseaware sensor. You cannot configure thresholds with time periods that overlap. -- [Receiving noise sensor events when noise events occur](/api/events/object)\ - For more information, see the [`noise_sensor.noise_threshold_triggered` event](/api/events/object). +- [Receiving noise sensor events when noise events occur](/api/noise_sensors/noise_thresholds/events)\ + For more information, see the [`noise_sensor.noise_threshold_triggered` event](/api/noise_sensors/noise_thresholds/events). --- diff --git a/mintlify-docs/device-and-system-integration-guides/schlage-locks/schlage-locks-setup-instructions.mdx b/mintlify-docs/device-and-system-integration-guides/schlage-locks/schlage-locks-setup-instructions.mdx index 96a109678..caca81b85 100644 --- a/mintlify-docs/device-and-system-integration-guides/schlage-locks/schlage-locks-setup-instructions.mdx +++ b/mintlify-docs/device-and-system-integration-guides/schlage-locks/schlage-locks-setup-instructions.mdx @@ -26,5 +26,5 @@ To control Schlage Connect or Connected Keypad locks with Z-Wave technology usin 2. Connect your lock to a Z-Wave hub.\ Before connecting your Schlage locks to the internet, you must first connect them to a Z-Wave hub. Follow the hub's setup process to link your locks to it. 3. Note your login credentials for SmartThings, that is, the hub to which you have connected your lock. -4. In the [Seam Connect Webview](/core-concepts/connect-webviews), select SmartThings. +4. In the Seam Connect Webview, select SmartThings. 5. In the Connect Webview, type the appropriate SmartThings credentials to add your devices to Seam. diff --git a/mintlify-docs/device-and-system-integration-guides/sensi-thermostats/get-started-with-sensi-thermostats.mdx b/mintlify-docs/device-and-system-integration-guides/sensi-thermostats/get-started-with-sensi-thermostats.mdx index a1349e89c..14a6209da 100644 --- a/mintlify-docs/device-and-system-integration-guides/sensi-thermostats/get-started-with-sensi-thermostats.mdx +++ b/mintlify-docs/device-and-system-integration-guides/sensi-thermostats/get-started-with-sensi-thermostats.mdx @@ -823,7 +823,7 @@ ActionAttempt( -You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/events/object). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. +You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/thermostats/events). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. To query `properties.current_climate_setting.hvac_mode_setting` for the device: diff --git a/mintlify-docs/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.mdx b/mintlify-docs/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.mdx index 4d84abec1..e8fa2cc33 100644 --- a/mintlify-docs/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.mdx +++ b/mintlify-docs/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.mdx @@ -788,7 +788,7 @@ ActionAttempt( -You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/events/object). +You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events). To query the `locked` status of the device: diff --git a/mintlify-docs/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.mdx b/mintlify-docs/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.mdx index 424295d05..cc687c61b 100644 --- a/mintlify-docs/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.mdx +++ b/mintlify-docs/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.mdx @@ -834,7 +834,7 @@ ActionAttempt( -You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/events/object). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. +You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/thermostats/events). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. To query `properties.current_climate_setting.hvac_mode_setting` for the device: diff --git a/mintlify-docs/device-and-system-integration-guides/ttlock-locks/get-started-with-ttlock-devices.mdx b/mintlify-docs/device-and-system-integration-guides/ttlock-locks/get-started-with-ttlock-devices.mdx index 38737fabe..e4ec38e76 100644 --- a/mintlify-docs/device-and-system-integration-guides/ttlock-locks/get-started-with-ttlock-devices.mdx +++ b/mintlify-docs/device-and-system-integration-guides/ttlock-locks/get-started-with-ttlock-devices.mdx @@ -790,7 +790,7 @@ ActionAttempt( -You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/events/object). +You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events). To query the `locked` status of the device: diff --git a/mintlify-docs/device-and-system-integration-guides/ttlock-locks/index.mdx b/mintlify-docs/device-and-system-integration-guides/ttlock-locks/index.mdx index 4928de42e..b9cc4be78 100644 --- a/mintlify-docs/device-and-system-integration-guides/ttlock-locks/index.mdx +++ b/mintlify-docs/device-and-system-integration-guides/ttlock-locks/index.mdx @@ -61,7 +61,7 @@ For instructions on connecting TTLock locks to Seam, see the [TTLock Setup Guide ### Lock Not Appearing in Seam -Your users must be the top administrator for each TTLock that they want to connect to Seam. That is, they must supply the credentials for the top administrator account when completing the [Connect Webview](/core-concepts/connect-webviews) to connect their TTLocks to Seam. +Your users must be the top administrator for each TTLock that they want to connect to Seam. That is, they must supply the credentials for the top administrator account when completing the Connect Webview to connect their TTLocks to Seam. ### Lock Not Paired to Gateway Error diff --git a/mintlify-docs/low-level-apis/smart-locks/access-codes/creating-access-codes/index.mdx b/mintlify-docs/low-level-apis/smart-locks/access-codes/creating-access-codes/index.mdx index 3f75d5ec6..09bced295 100644 --- a/mintlify-docs/low-level-apis/smart-locks/access-codes/creating-access-codes/index.mdx +++ b/mintlify-docs/low-level-apis/smart-locks/access-codes/creating-access-codes/index.mdx @@ -39,7 +39,7 @@ Before you attempt to create an [online](/low-level-apis/smart-locks/access-code Use [Get Device](/api/devices/get) for a specific device to return these capability flags. Then, use an `if` statement or similar check to confirm that the relevant flag is both present and `true` before attempting to create an access code. -If either of these capability flags is `false` or not present, you can view the [properties](/core-concepts/devices) of the device, [errors](/core-concepts/devices) or [warnings](/core-concepts/devices) for the device, and [events](/api/events/object) related to the device to learn more about the cause of these issues. For example, you could examine the following device properties: +If either of these capability flags is `false` or not present, you can view the [properties](/api/devices/object) of the device, [errors or warnings](/api/devices/errors) for the device, and [events](/api/devices/events) related to the device to learn more about the cause of these issues. For example, you could examine the following device properties: - `device.properties.model.has_built_in_keypad` - `device.properties.model.can_connect_accessory_keypad` diff --git a/mintlify-docs/low-level-apis/smart-locks/access-codes/index.mdx b/mintlify-docs/low-level-apis/smart-locks/access-codes/index.mdx index 260f537ae..2fcb6991f 100644 --- a/mintlify-docs/low-level-apis/smart-locks/access-codes/index.mdx +++ b/mintlify-docs/low-level-apis/smart-locks/access-codes/index.mdx @@ -125,7 +125,7 @@ To help your users identify codes set by Seam, Seam provides the name exactly as ## Linking Unlock Events and Access Codes -When a user unlocks a door using an access code, Seam issues a [`lock.unlocked` event](/api/events/object). Some device manufacturers include the ID of the access code in lock-related events. This information is useful for troubleshooting and logging. Further, if you name access codes in a way that identifies the associated users, you can use these `lock.unlocked` events to identify the users who unlocked the doors. +When a user unlocks a door using an access code, Seam issues a [`lock.unlocked` event](/api/locks/events). Some device manufacturers include the ID of the access code in lock-related events. This information is useful for troubleshooting and logging. Further, if you name access codes in a way that identifies the associated users, you can use these `lock.unlocked` events to identify the users who unlocked the doors. Currently, the following device manufacturers send the `access_code_id` in the `lock.unlocked` event: diff --git a/mintlify-docs/low-level-apis/smart-locks/lock-and-unlock.mdx b/mintlify-docs/low-level-apis/smart-locks/lock-and-unlock.mdx index d0b038c80..169d55839 100644 --- a/mintlify-docs/low-level-apis/smart-locks/lock-and-unlock.mdx +++ b/mintlify-docs/low-level-apis/smart-locks/lock-and-unlock.mdx @@ -24,7 +24,7 @@ Before you attempt to lock or unlock a device, be sure to confirm that your devi Use [Get Device](/api/devices/get) for a specific device to return these capability flags. Then, use an `if` statement or similar check to confirm that the relevant flag is both present and `true` before attempting to lock or unlock the device. -If either of these capability flags is `false` or not present, you can view the [properties](/core-concepts/devices) of the device, [errors](/core-concepts/devices) or [warnings](/core-concepts/devices) for the device, and [events](/api/events/object) related to the device to learn more about the cause of these issues. For example, you could examine `device.properties.online`. In addition, you could look for a `device.disconnected` event. +If either of these capability flags is `false` or not present, you can view the [properties](/api/devices/object) of the device, [errors or warnings](/api/devices/errors) for the device, and [events](/api/devices/events) related to the device to learn more about the cause of these issues. For example, you could examine `device.properties.online`. In addition, you could look for a `device.disconnected` event. **Request:** @@ -840,4 +840,4 @@ A lock or unlock event looks like the following: } ``` -For more information about the `lock.locked` and `lock.unlocked` attributes, please see[ Events](/api/events/object). +For more information about the `lock.locked` and `lock.unlocked` attributes, please see[ Events](/api/locks/events). From 146207d0ee5f41189eba3520e2d7fd59e181351c Mon Sep 17 00:00:00 2001 From: dawnho Date: Thu, 2 Jul 2026 11:35:02 -0700 Subject: [PATCH 2/4] docs: deep-link event and error references to their specific headers MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Now that the resource events pages and the new per-resource errors pages (locks, thermostats, phones — #1219) exist, link to the specific heading rather than the page top: - Event links whose text names a `resource.event` (e.g. `lock.unlocked`) now point at that event's anchor, e.g. /api/locks/events#lock.unlocked. 35 links. - The capability-troubleshooting sentences' "errors or warnings" links point at /api/devices/errors#device_offline — the specific error behind a non-functional capability (the sentence references `device.properties.online`). device_offline lives only on the device errors page, so this stays device-level and is content-correct. Anchor slugs are the heading's verbatim code (dots/underscores preserved, per existing anchors like #acs_system.errors.seam_bridge_disconnected). All 39 anchors verified against real headings. Merged latest main to pick up the new error pages. Still non-generated pages only. --- .../capability-guides/device-and-system-capabilities.mdx | 2 +- .../thermostats/configure-current-climate-settings.mdx | 4 ++-- .../activating-a-climate-preset.mdx | 2 +- .../creating-and-managing-thermostat-schedules.mdx | 2 +- mintlify-docs/capability-guides/thermostats/index.mdx | 2 +- .../setting-and-monitoring-temperature-thresholds.mdx | 2 +- ...-control-systems-connected-through-a-connect-webview.mdx | 6 +++--- .../verifying-successful-account-connection.mdx | 2 +- .../core-concepts/devices/displaying-device-health.mdx | 4 ++-- .../devices/displaying-device-power-status.mdx | 2 +- .../33-lock-devices/get-started-with-33-lock-devices.mdx | 2 +- .../4suites-locks/get-started-with-4suites-locks.mdx | 2 +- .../akiles-locks/get-started-with-akiles-locks.mdx | 2 +- .../august-locks/get-started-with-august-locks.mdx | 2 +- .../get-started-with-ecobee-thermostats.mdx | 2 +- .../get-started-with-nest-thermostats.mdx | 2 +- .../get-started-with-honeywell-thermostats.mdx | 2 +- .../igloohome-locks/index.mdx | 4 ++-- .../kwikset-locks/index.mdx | 4 ++-- .../minut-sensors/get-started-with-minut-sensors.mdx | 2 +- .../minut-sensors/index.mdx | 2 +- .../get-started-with-noiseaware-sensors.mdx | 2 +- .../noiseaware-sensors/index.mdx | 2 +- .../get-started-with-sensi-thermostats.mdx | 2 +- .../get-started-with-smartthings-hubs-+-smart-locks.mdx | 2 +- .../get-started-with-smartthings-hubs-+-thermostats.mdx | 2 +- .../ttlock-locks/get-started-with-ttlock-devices.mdx | 2 +- .../access-codes/creating-access-codes/index.mdx | 2 +- .../low-level-apis/smart-locks/access-codes/index.mdx | 2 +- .../low-level-apis/smart-locks/lock-and-unlock.mdx | 2 +- 30 files changed, 36 insertions(+), 36 deletions(-) diff --git a/mintlify-docs/capability-guides/device-and-system-capabilities.mdx b/mintlify-docs/capability-guides/device-and-system-capabilities.mdx index b682e9994..faf1bf256 100644 --- a/mintlify-docs/capability-guides/device-and-system-capabilities.mdx +++ b/mintlify-docs/capability-guides/device-and-system-capabilities.mdx @@ -21,7 +21,7 @@ All capability flags share the following behavior: - If `true`, the device has this capability, and this capability is functional on this device instance. - If `false`, the device has this capability, but the capability is not currently functional. - See the device [errors and warnings](/api/devices/errors) for more details about the cause of this issue. You can also examine the [properties](/api/devices/object) of the device and [events](/api/devices/events) related to the device to learn more about the cause of this issue. + See the device [errors and warnings](/api/devices/errors#device_offline) for more details about the cause of this issue. You can also examine the [properties](/api/devices/object) of the device and [events](/api/devices/events) related to the device to learn more about the cause of this issue. - If not present, the device does not have this capability. diff --git a/mintlify-docs/capability-guides/thermostats/configure-current-climate-settings.mdx b/mintlify-docs/capability-guides/thermostats/configure-current-climate-settings.mdx index 6be5c64f7..7439cd8d3 100644 --- a/mintlify-docs/capability-guides/thermostats/configure-current-climate-settings.mdx +++ b/mintlify-docs/capability-guides/thermostats/configure-current-climate-settings.mdx @@ -24,7 +24,7 @@ Note that it's important to check the capabilities of a thermostat before attemp These imperative operations return an [action attempt](../../core-concepts/action-attempts) that enables you to track the progress of the action. Poll this action attempt, until the action completes. -Further, Seam emits a [`thermostat.temperature_reached_set_point` event](/api/thermostats/events) when the thermostat reports a temperature within 1° Celsius of the heating or cooling temperature that you requested. +Further, Seam emits a [`thermostat.temperature_reached_set_point` event](/api/thermostats/events#thermostat.temperature_reached_set_point) when the thermostat reports a temperature within 1° Celsius of the heating or cooling temperature that you requested. --- @@ -118,7 +118,7 @@ Before you attempt to set the HVAC or fan mode settings for a thermostat, be sur Use the [`/devices/get`](/api/devices/get) endpoint for a specific device to return these capability flags. Then, use an `if` statement or similar check to confirm that the relevant flag is both present and `true` before attempting to perform the imperative thermostat action. -If the relevant capability flag is `false` or not present, you can view the [properties](/api/devices/object) of the device, [errors or warnings](/api/devices/errors) for the device, and [events](/api/devices/events) related to the device to learn more about the cause of these issues. For example, you could examine `device.properties.online`. In addition, you could look for a `device.disconnected` event. +If the relevant capability flag is `false` or not present, you can view the [properties](/api/devices/object) of the device, [errors or warnings](/api/devices/errors#device_offline) for the device, and [events](/api/devices/events) related to the device to learn more about the cause of these issues. For example, you could examine `device.properties.online`. In addition, you could look for a `device.disconnected` event. **Request:** diff --git a/mintlify-docs/capability-guides/thermostats/creating-and-managing-climate-presets/activating-a-climate-preset.mdx b/mintlify-docs/capability-guides/thermostats/creating-and-managing-climate-presets/activating-a-climate-preset.mdx index 590aa2dab..dfec0e26b 100644 --- a/mintlify-docs/capability-guides/thermostats/creating-and-managing-climate-presets/activating-a-climate-preset.mdx +++ b/mintlify-docs/capability-guides/thermostats/creating-and-managing-climate-presets/activating-a-climate-preset.mdx @@ -7,7 +7,7 @@ In addition to [scheduling](../creating-and-managing-thermostat-schedules) clima Activating a climate preset returns an [action attempt](../../../core-concepts/action-attempts) that enables you to track the progress of the action. Poll this action attempt, until the action completes. -Further, Seam emits a [`thermostat.temperature_reached_set_point` event](/api/thermostats/events) when the thermostat reports a temperature within 1° Celsius of the heating or cooling [set point](../understanding-thermostat-concepts/set-points) specified in the climate preset that you've activated. You can configure a [webhook](../../../developer-tools/webhooks) to watch for this event. +Further, Seam emits a [`thermostat.temperature_reached_set_point` event](/api/thermostats/events#thermostat.temperature_reached_set_point) when the thermostat reports a temperature within 1° Celsius of the heating or cooling [set point](../understanding-thermostat-concepts/set-points) specified in the climate preset that you've activated. You can configure a [webhook](../../../developer-tools/webhooks) to watch for this event. --- diff --git a/mintlify-docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.mdx b/mintlify-docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.mdx index ca05ef1f7..8a408b8f3 100644 --- a/mintlify-docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.mdx +++ b/mintlify-docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.mdx @@ -102,7 +102,7 @@ In the Seam API, use the `starts_at` and `ends_at` parameters to define the time `starts_at` is required and must be unique within all the schedules for the thermostat. However, if you want to schedule a climate preset that starts immediately, set `start_at` to a time in the past. Alternately, you can [activate a climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets/activating-a-climate-preset) immediately. -After a scheduled climate preset starts, Seam emits a [`thermostat.temperature_reached_set_point` event](/api/thermostats/events) when the thermostat reports a temperature within 1° Celsius of the heating or cooling [set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) specified in this climate preset. You can configure a [webhook](../../developer-tools/webhooks) to watch for this event. +After a scheduled climate preset starts, Seam emits a [`thermostat.temperature_reached_set_point` event](/api/thermostats/events#thermostat.temperature_reached_set_point) when the thermostat reports a temperature within 1° Celsius of the heating or cooling [set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) specified in this climate preset. You can configure a [webhook](../../developer-tools/webhooks) to watch for this event. --- diff --git a/mintlify-docs/capability-guides/thermostats/index.mdx b/mintlify-docs/capability-guides/thermostats/index.mdx index ea654500f..813f0137d 100644 --- a/mintlify-docs/capability-guides/thermostats/index.mdx +++ b/mintlify-docs/capability-guides/thermostats/index.mdx @@ -36,7 +36,7 @@ First, connect your users' thermostats to Seam using the [Seam Console](/core-co Retrieve and monitor your users' thermostats using the [`/thermostats/list`](/api/thermostats/list) and [`/devices/get`](/api/devices/get) endpoints. The Seam API returns robust, up-to-date information about your connected thermostats. In addition, you can use these endpoints to learn the capabilities of each thermostat. -Further, you can use the [`/thermostats/set_temperature_threshold`](/api/thermostats/set_temperature_threshold) endpoint to set upper and lower acceptable temperature bounds. If the thermostat reports a temperature outside this range, Seam emits a [`thermostat.temperature_threshold_exceeded` event](/api/thermostats/events). +Further, you can use the [`/thermostats/set_temperature_threshold`](/api/thermostats/set_temperature_threshold) endpoint to set upper and lower acceptable temperature bounds. If the thermostat reports a temperature outside this range, Seam emits a [`thermostat.temperature_threshold_exceeded` event](/api/thermostats/events#thermostat.temperature_threshold_exceeded). ### Perform Remote Management diff --git a/mintlify-docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.mdx b/mintlify-docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.mdx index 20773a01c..cd1a1bf02 100644 --- a/mintlify-docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.mdx +++ b/mintlify-docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.mdx @@ -3,7 +3,7 @@ title: 'Setting and Monitoring Temperature Thresholds' description: 'Learn how to use temperature thresholds to monitor your thermostat for potential HVAC system misuse or malfunctioning.' --- -You can configure Seam to emit a [`thermostat.temperature_threshold_exceeded` event](/api/thermostats/events) if a thermostat reports a temperature outside a specific threshold range. This capability helps you to monitor your thermostats proactively, alerting you to potential HVAC system misuse or malfunctioning. +You can configure Seam to emit a [`thermostat.temperature_threshold_exceeded` event](/api/thermostats/events#thermostat.temperature_threshold_exceeded) if a thermostat reports a temperature outside a specific threshold range. This capability helps you to monitor your thermostats proactively, alerting you to potential HVAC system misuse or malfunctioning. Use the [`/thermostats/set_temperature_threshold`](/api/thermostats/set_temperature_threshold) endpoint to set upper and lower acceptable temperature bounds. Then, you can use a [webhook](../../developer-tools/webhooks) to monitor for `thermostat.temperature_threshold_exceeded` events. diff --git a/mintlify-docs/core-concepts/connect-webviews/retrieving-devices-or-access-control-systems-connected-through-a-connect-webview.mdx b/mintlify-docs/core-concepts/connect-webviews/retrieving-devices-or-access-control-systems-connected-through-a-connect-webview.mdx index d93092135..612e3a4a2 100644 --- a/mintlify-docs/core-concepts/connect-webviews/retrieving-devices-or-access-control-systems-connected-through-a-connect-webview.mdx +++ b/mintlify-docs/core-concepts/connect-webviews/retrieving-devices-or-access-control-systems-connected-through-a-connect-webview.mdx @@ -3,7 +3,7 @@ title: 'Retrieving Devices or Access Control Systems Connected Through a Connect description: 'Learn how to retrieve the set of devices or ACS that your app user connected to Seam through a specific Connect Webview.' --- -When your app user completes a [Connect Webview](./) authorization flow successfully, the resulting [`connected_account.connected` event](/api/connected_accounts/events) includes a `connected_account_id`. Also, once the connection is successful, the [`connect_webview` object](/api/connect_webviews/object) includes the `connected_account_id`. +When your app user completes a [Connect Webview](./) authorization flow successfully, the resulting [`connected_account.connected` event](/api/connected_accounts/events#connected_account.connected) includes a `connected_account_id`. Also, once the connection is successful, the [`connect_webview` object](/api/connect_webviews/object) includes the `connected_account_id`. The first step in controlling connected devices or a connected ACS is to retrieve the newly-connected set of devices or ACS. @@ -17,7 +17,7 @@ Use this `connected_account_id` in a [List Devices](/api/devices/list) command t If you set `wait_for_device_creation` to `false` when [creating the Connect Webview](/core-concepts/connect-webviews/embedding-a-connect-webview-in-your-app#step-1-open-a-connect-webview), you should wait for the [`connected_account.completed_first_sync` - event](/api/connected_accounts/events) before retrieving the user's + event](/api/connected_accounts/events#connected_account.completed_first_sync) before retrieving the user's devices. This event indicates that Seam has finished the first sync of the connected account and the devices are now available. @@ -173,7 +173,7 @@ Use this `connected_account_id` in a [List ACS Systems](/api/acs/systems/list) c If you set `wait_for_device_creation` to `false` when [creating the Connect Webview](/core-concepts/connect-webviews/embedding-a-connect-webview-in-your-app#step-1-open-a-connect-webview), you should wait for the [`connected_account.completed_first_sync` - event](/api/connected_accounts/events) before retrieving the user's + event](/api/connected_accounts/events#connected_account.completed_first_sync) before retrieving the user's ACS. This event indicates that Seam has finished the first sync of the connected account and the `acs_system` is now available. diff --git a/mintlify-docs/core-concepts/connect-webviews/verifying-successful-account-connection.mdx b/mintlify-docs/core-concepts/connect-webviews/verifying-successful-account-connection.mdx index d057cbbaa..43b6546d8 100644 --- a/mintlify-docs/core-concepts/connect-webviews/verifying-successful-account-connection.mdx +++ b/mintlify-docs/core-concepts/connect-webviews/verifying-successful-account-connection.mdx @@ -145,7 +145,7 @@ ConnectWebview( ## **Webhook** -When Seam successfully establishes the connection to the user's device or ACS account, Seam emits a [`connected_account.connected` event](/api/connected_accounts/events). This event includes a `connect_webview_id` property. +When Seam successfully establishes the connection to the user's device or ACS account, Seam emits a [`connected_account.connected` event](/api/connected_accounts/events#connected_account.connected). This event includes a `connect_webview_id` property. To avoid polling, use a Seam webhook to monitor for a `connected_account.connected` event with a `connect_webview_id` that matches the `connect_webview_id` of the appropriate Connect Webview instance. diff --git a/mintlify-docs/core-concepts/devices/displaying-device-health.mdx b/mintlify-docs/core-concepts/devices/displaying-device-health.mdx index e910fa277..73fde7878 100644 --- a/mintlify-docs/core-concepts/devices/displaying-device-health.mdx +++ b/mintlify-docs/core-concepts/devices/displaying-device-health.mdx @@ -101,7 +101,7 @@ Online: True ## Get Device Status Using Connection-Related Events -When a device connection or disconnection occurs, Seam generates a [`device.connected`](/api/devices/events) or [`device.disconnected`](/api/devices/events) event, respectively. You can retrieve these events using a [List Events](/api/events/list) request or through [webhooks](../../developer-tools/webhooks) and then display the corresponding status in your app. +When a device connection or disconnection occurs, Seam generates a [`device.connected`](/api/devices/events#device.connected) or [`device.disconnected`](/api/devices/events#device.disconnected) event, respectively. You can retrieve these events using a [List Events](/api/events/list) request or through [webhooks](../../developer-tools/webhooks) and then display the corresponding status in your app. To help you test your app against events—like device disconnection or @@ -114,7 +114,7 @@ When a device connection or disconnection occurs, Seam generates a [`device.conn ### Get Connection-Related Events Using a List Events Request -When issuing a [List Events](/api/events/list) request to retrieve [`device.connected`](/api/devices/events) or [`device.disconnected`](/api/devices/events) events for a specific device, include the following parameters: +When issuing a [List Events](/api/events/list) request to retrieve [`device.connected`](/api/devices/events#device.connected) or [`device.disconnected`](/api/devices/events#device.disconnected) events for a specific device, include the following parameters:
diff --git a/mintlify-docs/core-concepts/devices/displaying-device-power-status.mdx b/mintlify-docs/core-concepts/devices/displaying-device-power-status.mdx index e6ded3723..63ca461ba 100644 --- a/mintlify-docs/core-concepts/devices/displaying-device-power-status.mdx +++ b/mintlify-docs/core-concepts/devices/displaying-device-power-status.mdx @@ -235,7 +235,7 @@ You can retrieve these events using a [List Events](/api/events/list) request or ### Get Battery-Related Events Using a List Events Request -When issuing a [List Events](/api/events/list) request to retrieve [`device.low_battery`](/api/devices/events) or [`device.battery_status_changed`](/api/devices/events) events for a specific device, include the following parameters: +When issuing a [List Events](/api/events/list) request to retrieve [`device.low_battery`](/api/devices/events#device.low_battery) or [`device.battery_status_changed`](/api/devices/events#device.battery_status_changed) events for a specific device, include the following parameters:
diff --git a/mintlify-docs/device-and-system-integration-guides/33-lock-devices/get-started-with-33-lock-devices.mdx b/mintlify-docs/device-and-system-integration-guides/33-lock-devices/get-started-with-33-lock-devices.mdx index 86d5de66e..d885d384c 100644 --- a/mintlify-docs/device-and-system-integration-guides/33-lock-devices/get-started-with-33-lock-devices.mdx +++ b/mintlify-docs/device-and-system-integration-guides/33-lock-devices/get-started-with-33-lock-devices.mdx @@ -783,7 +783,7 @@ ActionAttempt( -You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events). +You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events#lock.unlocked). To query the `locked` status of the device: diff --git a/mintlify-docs/device-and-system-integration-guides/4suites-locks/get-started-with-4suites-locks.mdx b/mintlify-docs/device-and-system-integration-guides/4suites-locks/get-started-with-4suites-locks.mdx index af5f5c5e5..9e5e6b44b 100644 --- a/mintlify-docs/device-and-system-integration-guides/4suites-locks/get-started-with-4suites-locks.mdx +++ b/mintlify-docs/device-and-system-integration-guides/4suites-locks/get-started-with-4suites-locks.mdx @@ -766,7 +766,7 @@ ActionAttempt( -You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events). +You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events#lock.unlocked). To query the `locked` status of the device: diff --git a/mintlify-docs/device-and-system-integration-guides/akiles-locks/get-started-with-akiles-locks.mdx b/mintlify-docs/device-and-system-integration-guides/akiles-locks/get-started-with-akiles-locks.mdx index d11bdc373..0a19bde4a 100644 --- a/mintlify-docs/device-and-system-integration-guides/akiles-locks/get-started-with-akiles-locks.mdx +++ b/mintlify-docs/device-and-system-integration-guides/akiles-locks/get-started-with-akiles-locks.mdx @@ -766,7 +766,7 @@ ActionAttempt( -You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events). +You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events#lock.unlocked). To query the `locked` status of the device: diff --git a/mintlify-docs/device-and-system-integration-guides/august-locks/get-started-with-august-locks.mdx b/mintlify-docs/device-and-system-integration-guides/august-locks/get-started-with-august-locks.mdx index 2fb5167f5..0110b2195 100644 --- a/mintlify-docs/device-and-system-integration-guides/august-locks/get-started-with-august-locks.mdx +++ b/mintlify-docs/device-and-system-integration-guides/august-locks/get-started-with-august-locks.mdx @@ -798,7 +798,7 @@ ActionAttempt( -You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events). +You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events#lock.unlocked). To query the `locked` status of the device: diff --git a/mintlify-docs/device-and-system-integration-guides/ecobee-thermostats/get-started-with-ecobee-thermostats.mdx b/mintlify-docs/device-and-system-integration-guides/ecobee-thermostats/get-started-with-ecobee-thermostats.mdx index 00dc76e04..2dd67fdf6 100644 --- a/mintlify-docs/device-and-system-integration-guides/ecobee-thermostats/get-started-with-ecobee-thermostats.mdx +++ b/mintlify-docs/device-and-system-integration-guides/ecobee-thermostats/get-started-with-ecobee-thermostats.mdx @@ -840,7 +840,7 @@ ActionAttempt( -You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/thermostats/events). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. +You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/thermostats/events#thermostat.manually_adjusted). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. To query `properties.current_climate_setting.hvac_mode_setting` for the device: diff --git a/mintlify-docs/device-and-system-integration-guides/google-nest-thermostats/get-started-with-nest-thermostats.mdx b/mintlify-docs/device-and-system-integration-guides/google-nest-thermostats/get-started-with-nest-thermostats.mdx index 99b662f46..d876f9e9b 100644 --- a/mintlify-docs/device-and-system-integration-guides/google-nest-thermostats/get-started-with-nest-thermostats.mdx +++ b/mintlify-docs/device-and-system-integration-guides/google-nest-thermostats/get-started-with-nest-thermostats.mdx @@ -833,7 +833,7 @@ ActionAttempt( -You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/thermostats/events). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. +You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/thermostats/events#thermostat.manually_adjusted). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. To query `properties.current_climate_setting.hvac_mode_setting` for the device: diff --git a/mintlify-docs/device-and-system-integration-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.mdx b/mintlify-docs/device-and-system-integration-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.mdx index ef7caf6c4..7468d9611 100644 --- a/mintlify-docs/device-and-system-integration-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.mdx +++ b/mintlify-docs/device-and-system-integration-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.mdx @@ -831,7 +831,7 @@ ActionAttempt( -You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/thermostats/events). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. +You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/thermostats/events#thermostat.manually_adjusted). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. To query `properties.current_climate_setting.hvac_mode_setting` for the device: diff --git a/mintlify-docs/device-and-system-integration-guides/igloohome-locks/index.mdx b/mintlify-docs/device-and-system-integration-guides/igloohome-locks/index.mdx index aabaf4b5f..7b5e6227c 100644 --- a/mintlify-docs/device-and-system-integration-guides/igloohome-locks/index.mdx +++ b/mintlify-docs/device-and-system-integration-guides/igloohome-locks/index.mdx @@ -80,11 +80,11 @@ Seam supports the following events and event property values for igloohome devic ### igloohome Auto-Relock -igloohome devices have an auto-relock feature that automatically locks the device after a configurable period of time, for example, 30 seconds. The Seam API reports these auto-relock occurrences by emitting a [`lock.locked` event](/api/locks/events) with `automatic` as the value for the `method` property. +igloohome devices have an auto-relock feature that automatically locks the device after a configurable period of time, for example, 30 seconds. The Seam API reports these auto-relock occurrences by emitting a [`lock.locked` event](/api/locks/events#lock.locked) with `automatic` as the value for the `method` property. ### igloohome Access Denied Event -Each time an igloohome device detects an invalid attempt of entry, Seam emits a [`lock.access_denied` event](/api/locks/events). Invalid entry attempts include entering the wrong PIN, exceeding the PIN length, and using an invalid key card. The igloohome lock also flashes red to indicate an invalid attempt. If too many invalid attempts occur, igloohome locks produce a Keypad Security Lockout alarm, accompanied by light and sound indicators. For more information, see the igloohome support articles on [keypad security](https://support.igloohome.co/support/solutions/articles/35000169627-keypad-security-lockout-activated-and-deactivated) and [incorrect PINs](https://support.igloohome.co/support/solutions/articles/35000169625-incorrect-pin). +Each time an igloohome device detects an invalid attempt of entry, Seam emits a [`lock.access_denied` event](/api/locks/events#lock.access_denied). Invalid entry attempts include entering the wrong PIN, exceeding the PIN length, and using an invalid key card. The igloohome lock also flashes red to indicate an invalid attempt. If too many invalid attempts occur, igloohome locks produce a Keypad Security Lockout alarm, accompanied by light and sound indicators. For more information, see the igloohome support articles on [keypad security](https://support.igloohome.co/support/solutions/articles/35000169627-keypad-security-lockout-activated-and-deactivated) and [incorrect PINs](https://support.igloohome.co/support/solutions/articles/35000169625-incorrect-pin). --- diff --git a/mintlify-docs/device-and-system-integration-guides/kwikset-locks/index.mdx b/mintlify-docs/device-and-system-integration-guides/kwikset-locks/index.mdx index a314b623e..c2e5dbfc4 100644 --- a/mintlify-docs/device-and-system-integration-guides/kwikset-locks/index.mdx +++ b/mintlify-docs/device-and-system-integration-guides/kwikset-locks/index.mdx @@ -89,11 +89,11 @@ Seam supports the following events and event property values for Kwikset devices ### Kwikset Auto-Lock -Kwikset devices have an auto-lock feature that automatically locks the device after a configurable period of time, for example, 30 seconds. The Seam API reports these auto-lock occurrences by emitting a [`lock.locked` event](/api/locks/events) with `automatic` as the value for the `method` property. +Kwikset devices have an auto-lock feature that automatically locks the device after a configurable period of time, for example, 30 seconds. The Seam API reports these auto-lock occurrences by emitting a [`lock.locked` event](/api/locks/events#lock.locked) with `automatic` as the value for the `method` property. ### Kwikset Access Denied Event -The Seam API emits a [`lock.access_denied` event](/api/locks/events) when an incorrect access code is entered three times in a row on a Kwikset device. The Kwikset device also emits warning beeps for approximately 15 seconds, and the keypad is locked during this time. The keypad remains locked for one minute after the warning beeps end. +The Seam API emits a [`lock.access_denied` event](/api/locks/events#lock.access_denied) when an incorrect access code is entered three times in a row on a Kwikset device. The Kwikset device also emits warning beeps for approximately 15 seconds, and the keypad is locked during this time. The keypad remains locked for one minute after the warning beeps end. --- diff --git a/mintlify-docs/device-and-system-integration-guides/minut-sensors/get-started-with-minut-sensors.mdx b/mintlify-docs/device-and-system-integration-guides/minut-sensors/get-started-with-minut-sensors.mdx index fcc1a9337..d2da78b05 100644 --- a/mintlify-docs/device-and-system-integration-guides/minut-sensors/get-started-with-minut-sensors.mdx +++ b/mintlify-docs/device-and-system-integration-guides/minut-sensors/get-started-with-minut-sensors.mdx @@ -142,7 +142,7 @@ Navigate to the URL returned by the Webview object. Since you are using a sandbo ### Get the New Webview -After you complete the login above, you'll get an event for [`connected_account.created`](/api/connected_accounts/events)if you set up a [webhook handler](/developer-tools/webhooks). Otherwise you can just poll for the webview until it's status changes, as shown below: +After you complete the login above, you'll get an event for [`connected_account.created`](/api/connected_accounts/events#connected_account.created)if you set up a [webhook handler](/developer-tools/webhooks). Otherwise you can just poll for the webview until it's status changes, as shown below: diff --git a/mintlify-docs/device-and-system-integration-guides/minut-sensors/index.mdx b/mintlify-docs/device-and-system-integration-guides/minut-sensors/index.mdx index 629354535..25d299bbf 100644 --- a/mintlify-docs/device-and-system-integration-guides/minut-sensors/index.mdx +++ b/mintlify-docs/device-and-system-integration-guides/minut-sensors/index.mdx @@ -43,7 +43,7 @@ We support the following features: - [Configuring noise threshold settings](/capability-guides/noise-sensors/configure-noise-threshold-settings)\ You can configure a maximum of two noise thresholds per Minut sensor. The first threshold is required and represents the regular threshold for the whole day. The second threshold is optional and represents the threshold for the quiet hours timeframe. - [Receiving noise sensor events when noise events occur](/api/noise_sensors/noise_thresholds/events)\ - For more information, see the [`noise_sensor.noise_threshold_triggered` event](/api/noise_sensors/noise_thresholds/events). + For more information, see the [`noise_sensor.noise_threshold_triggered` event](/api/noise_sensors/noise_thresholds/events#noise_sensor.noise_threshold_triggered). --- diff --git a/mintlify-docs/device-and-system-integration-guides/noiseaware-sensors/get-started-with-noiseaware-sensors.mdx b/mintlify-docs/device-and-system-integration-guides/noiseaware-sensors/get-started-with-noiseaware-sensors.mdx index d2b8bb0c2..3e50dbfca 100644 --- a/mintlify-docs/device-and-system-integration-guides/noiseaware-sensors/get-started-with-noiseaware-sensors.mdx +++ b/mintlify-docs/device-and-system-integration-guides/noiseaware-sensors/get-started-with-noiseaware-sensors.mdx @@ -152,7 +152,7 @@ Navigate to the URL returned by the Webview object. Since you are using a sandbo ### Get the New Webview -After you complete the login above, you'll get an event for [`connected_account.created`](/api/connected_accounts/events)if you set up a [webhook handler](/developer-tools/webhooks). Otherwise you can just poll for the webview until it's status changes, as shown below: +After you complete the login above, you'll get an event for [`connected_account.created`](/api/connected_accounts/events#connected_account.created)if you set up a [webhook handler](/developer-tools/webhooks). Otherwise you can just poll for the webview until it's status changes, as shown below: diff --git a/mintlify-docs/device-and-system-integration-guides/noiseaware-sensors/index.mdx b/mintlify-docs/device-and-system-integration-guides/noiseaware-sensors/index.mdx index 3c00e4403..864ca5560 100644 --- a/mintlify-docs/device-and-system-integration-guides/noiseaware-sensors/index.mdx +++ b/mintlify-docs/device-and-system-integration-guides/noiseaware-sensors/index.mdx @@ -43,7 +43,7 @@ We support the following features: - [Configuring noise threshold settings](/capability-guides/noise-sensors/configure-noise-threshold-settings)\ You can configure a maximum of one noise threshold per hour per Noiseaware sensor. You cannot configure thresholds with time periods that overlap. - [Receiving noise sensor events when noise events occur](/api/noise_sensors/noise_thresholds/events)\ - For more information, see the [`noise_sensor.noise_threshold_triggered` event](/api/noise_sensors/noise_thresholds/events). + For more information, see the [`noise_sensor.noise_threshold_triggered` event](/api/noise_sensors/noise_thresholds/events#noise_sensor.noise_threshold_triggered). --- diff --git a/mintlify-docs/device-and-system-integration-guides/sensi-thermostats/get-started-with-sensi-thermostats.mdx b/mintlify-docs/device-and-system-integration-guides/sensi-thermostats/get-started-with-sensi-thermostats.mdx index 14a6209da..dd45ffb5a 100644 --- a/mintlify-docs/device-and-system-integration-guides/sensi-thermostats/get-started-with-sensi-thermostats.mdx +++ b/mintlify-docs/device-and-system-integration-guides/sensi-thermostats/get-started-with-sensi-thermostats.mdx @@ -823,7 +823,7 @@ ActionAttempt( -You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/thermostats/events). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. +You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/thermostats/events#thermostat.manually_adjusted). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. To query `properties.current_climate_setting.hvac_mode_setting` for the device: diff --git a/mintlify-docs/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.mdx b/mintlify-docs/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.mdx index e8fa2cc33..06406a002 100644 --- a/mintlify-docs/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.mdx +++ b/mintlify-docs/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.mdx @@ -788,7 +788,7 @@ ActionAttempt( -You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events). +You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events#lock.unlocked). To query the `locked` status of the device: diff --git a/mintlify-docs/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.mdx b/mintlify-docs/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.mdx index cc687c61b..0c8e7c08f 100644 --- a/mintlify-docs/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.mdx +++ b/mintlify-docs/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.mdx @@ -834,7 +834,7 @@ ActionAttempt( -You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/thermostats/events). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. +You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/thermostats/events#thermostat.manually_adjusted). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. To query `properties.current_climate_setting.hvac_mode_setting` for the device: diff --git a/mintlify-docs/device-and-system-integration-guides/ttlock-locks/get-started-with-ttlock-devices.mdx b/mintlify-docs/device-and-system-integration-guides/ttlock-locks/get-started-with-ttlock-devices.mdx index e4ec38e76..feec2b38f 100644 --- a/mintlify-docs/device-and-system-integration-guides/ttlock-locks/get-started-with-ttlock-devices.mdx +++ b/mintlify-docs/device-and-system-integration-guides/ttlock-locks/get-started-with-ttlock-devices.mdx @@ -790,7 +790,7 @@ ActionAttempt( -You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events). +You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events#lock.unlocked). To query the `locked` status of the device: diff --git a/mintlify-docs/low-level-apis/smart-locks/access-codes/creating-access-codes/index.mdx b/mintlify-docs/low-level-apis/smart-locks/access-codes/creating-access-codes/index.mdx index 09bced295..17418a002 100644 --- a/mintlify-docs/low-level-apis/smart-locks/access-codes/creating-access-codes/index.mdx +++ b/mintlify-docs/low-level-apis/smart-locks/access-codes/creating-access-codes/index.mdx @@ -39,7 +39,7 @@ Before you attempt to create an [online](/low-level-apis/smart-locks/access-code Use [Get Device](/api/devices/get) for a specific device to return these capability flags. Then, use an `if` statement or similar check to confirm that the relevant flag is both present and `true` before attempting to create an access code. -If either of these capability flags is `false` or not present, you can view the [properties](/api/devices/object) of the device, [errors or warnings](/api/devices/errors) for the device, and [events](/api/devices/events) related to the device to learn more about the cause of these issues. For example, you could examine the following device properties: +If either of these capability flags is `false` or not present, you can view the [properties](/api/devices/object) of the device, [errors or warnings](/api/devices/errors#device_offline) for the device, and [events](/api/devices/events) related to the device to learn more about the cause of these issues. For example, you could examine the following device properties: - `device.properties.model.has_built_in_keypad` - `device.properties.model.can_connect_accessory_keypad` diff --git a/mintlify-docs/low-level-apis/smart-locks/access-codes/index.mdx b/mintlify-docs/low-level-apis/smart-locks/access-codes/index.mdx index 2fcb6991f..110ffabce 100644 --- a/mintlify-docs/low-level-apis/smart-locks/access-codes/index.mdx +++ b/mintlify-docs/low-level-apis/smart-locks/access-codes/index.mdx @@ -125,7 +125,7 @@ To help your users identify codes set by Seam, Seam provides the name exactly as ## Linking Unlock Events and Access Codes -When a user unlocks a door using an access code, Seam issues a [`lock.unlocked` event](/api/locks/events). Some device manufacturers include the ID of the access code in lock-related events. This information is useful for troubleshooting and logging. Further, if you name access codes in a way that identifies the associated users, you can use these `lock.unlocked` events to identify the users who unlocked the doors. +When a user unlocks a door using an access code, Seam issues a [`lock.unlocked` event](/api/locks/events#lock.unlocked). Some device manufacturers include the ID of the access code in lock-related events. This information is useful for troubleshooting and logging. Further, if you name access codes in a way that identifies the associated users, you can use these `lock.unlocked` events to identify the users who unlocked the doors. Currently, the following device manufacturers send the `access_code_id` in the `lock.unlocked` event: diff --git a/mintlify-docs/low-level-apis/smart-locks/lock-and-unlock.mdx b/mintlify-docs/low-level-apis/smart-locks/lock-and-unlock.mdx index 169d55839..db47e8687 100644 --- a/mintlify-docs/low-level-apis/smart-locks/lock-and-unlock.mdx +++ b/mintlify-docs/low-level-apis/smart-locks/lock-and-unlock.mdx @@ -24,7 +24,7 @@ Before you attempt to lock or unlock a device, be sure to confirm that your devi Use [Get Device](/api/devices/get) for a specific device to return these capability flags. Then, use an `if` statement or similar check to confirm that the relevant flag is both present and `true` before attempting to lock or unlock the device. -If either of these capability flags is `false` or not present, you can view the [properties](/api/devices/object) of the device, [errors or warnings](/api/devices/errors) for the device, and [events](/api/devices/events) related to the device to learn more about the cause of these issues. For example, you could examine `device.properties.online`. In addition, you could look for a `device.disconnected` event. +If either of these capability flags is `false` or not present, you can view the [properties](/api/devices/object) of the device, [errors or warnings](/api/devices/errors#device_offline) for the device, and [events](/api/devices/events) related to the device to learn more about the cause of these issues. For example, you could examine `device.properties.online`. In addition, you could look for a `device.disconnected` event. **Request:** From add49d60c33f1df2c26758bd591bef8daad3bdee Mon Sep 17 00:00:00 2001 From: dawnho Date: Thu, 2 Jul 2026 12:38:17 -0700 Subject: [PATCH 3/4] fix: use hyphenated anchor slugs for event deep links Mintlify slugs a code heading like `lock.unlocked` as #lock-unlocked (dot -> hyphen, underscores kept), not #lock.unlocked. The dotted anchors failed the Mintlify broken-links/anchors check. Hyphenate the dot in all 35 event deep-link anchors; verified locally with `mintlify broken-links --check-anchors` (no broken links). #device_offline was already valid. --- .../thermostats/configure-current-climate-settings.mdx | 2 +- .../activating-a-climate-preset.mdx | 2 +- .../creating-and-managing-thermostat-schedules.mdx | 2 +- mintlify-docs/capability-guides/thermostats/index.mdx | 2 +- .../setting-and-monitoring-temperature-thresholds.mdx | 2 +- ...-control-systems-connected-through-a-connect-webview.mdx | 6 +++--- .../verifying-successful-account-connection.mdx | 2 +- .../core-concepts/devices/displaying-device-health.mdx | 4 ++-- .../devices/displaying-device-power-status.mdx | 2 +- .../33-lock-devices/get-started-with-33-lock-devices.mdx | 2 +- .../4suites-locks/get-started-with-4suites-locks.mdx | 2 +- .../akiles-locks/get-started-with-akiles-locks.mdx | 2 +- .../august-locks/get-started-with-august-locks.mdx | 2 +- .../get-started-with-ecobee-thermostats.mdx | 2 +- .../get-started-with-nest-thermostats.mdx | 2 +- .../get-started-with-honeywell-thermostats.mdx | 2 +- .../igloohome-locks/index.mdx | 4 ++-- .../kwikset-locks/index.mdx | 4 ++-- .../minut-sensors/get-started-with-minut-sensors.mdx | 2 +- .../minut-sensors/index.mdx | 2 +- .../get-started-with-noiseaware-sensors.mdx | 2 +- .../noiseaware-sensors/index.mdx | 2 +- .../get-started-with-sensi-thermostats.mdx | 2 +- .../get-started-with-smartthings-hubs-+-smart-locks.mdx | 2 +- .../get-started-with-smartthings-hubs-+-thermostats.mdx | 2 +- .../ttlock-locks/get-started-with-ttlock-devices.mdx | 2 +- .../low-level-apis/smart-locks/access-codes/index.mdx | 2 +- 27 files changed, 32 insertions(+), 32 deletions(-) diff --git a/mintlify-docs/capability-guides/thermostats/configure-current-climate-settings.mdx b/mintlify-docs/capability-guides/thermostats/configure-current-climate-settings.mdx index 7439cd8d3..00c258695 100644 --- a/mintlify-docs/capability-guides/thermostats/configure-current-climate-settings.mdx +++ b/mintlify-docs/capability-guides/thermostats/configure-current-climate-settings.mdx @@ -24,7 +24,7 @@ Note that it's important to check the capabilities of a thermostat before attemp These imperative operations return an [action attempt](../../core-concepts/action-attempts) that enables you to track the progress of the action. Poll this action attempt, until the action completes. -Further, Seam emits a [`thermostat.temperature_reached_set_point` event](/api/thermostats/events#thermostat.temperature_reached_set_point) when the thermostat reports a temperature within 1° Celsius of the heating or cooling temperature that you requested. +Further, Seam emits a [`thermostat.temperature_reached_set_point` event](/api/thermostats/events#thermostat-temperature_reached_set_point) when the thermostat reports a temperature within 1° Celsius of the heating or cooling temperature that you requested. --- diff --git a/mintlify-docs/capability-guides/thermostats/creating-and-managing-climate-presets/activating-a-climate-preset.mdx b/mintlify-docs/capability-guides/thermostats/creating-and-managing-climate-presets/activating-a-climate-preset.mdx index dfec0e26b..58f6426fb 100644 --- a/mintlify-docs/capability-guides/thermostats/creating-and-managing-climate-presets/activating-a-climate-preset.mdx +++ b/mintlify-docs/capability-guides/thermostats/creating-and-managing-climate-presets/activating-a-climate-preset.mdx @@ -7,7 +7,7 @@ In addition to [scheduling](../creating-and-managing-thermostat-schedules) clima Activating a climate preset returns an [action attempt](../../../core-concepts/action-attempts) that enables you to track the progress of the action. Poll this action attempt, until the action completes. -Further, Seam emits a [`thermostat.temperature_reached_set_point` event](/api/thermostats/events#thermostat.temperature_reached_set_point) when the thermostat reports a temperature within 1° Celsius of the heating or cooling [set point](../understanding-thermostat-concepts/set-points) specified in the climate preset that you've activated. You can configure a [webhook](../../../developer-tools/webhooks) to watch for this event. +Further, Seam emits a [`thermostat.temperature_reached_set_point` event](/api/thermostats/events#thermostat-temperature_reached_set_point) when the thermostat reports a temperature within 1° Celsius of the heating or cooling [set point](../understanding-thermostat-concepts/set-points) specified in the climate preset that you've activated. You can configure a [webhook](../../../developer-tools/webhooks) to watch for this event. --- diff --git a/mintlify-docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.mdx b/mintlify-docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.mdx index 8a408b8f3..494ca2c7b 100644 --- a/mintlify-docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.mdx +++ b/mintlify-docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.mdx @@ -102,7 +102,7 @@ In the Seam API, use the `starts_at` and `ends_at` parameters to define the time `starts_at` is required and must be unique within all the schedules for the thermostat. However, if you want to schedule a climate preset that starts immediately, set `start_at` to a time in the past. Alternately, you can [activate a climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets/activating-a-climate-preset) immediately. -After a scheduled climate preset starts, Seam emits a [`thermostat.temperature_reached_set_point` event](/api/thermostats/events#thermostat.temperature_reached_set_point) when the thermostat reports a temperature within 1° Celsius of the heating or cooling [set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) specified in this climate preset. You can configure a [webhook](../../developer-tools/webhooks) to watch for this event. +After a scheduled climate preset starts, Seam emits a [`thermostat.temperature_reached_set_point` event](/api/thermostats/events#thermostat-temperature_reached_set_point) when the thermostat reports a temperature within 1° Celsius of the heating or cooling [set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) specified in this climate preset. You can configure a [webhook](../../developer-tools/webhooks) to watch for this event. --- diff --git a/mintlify-docs/capability-guides/thermostats/index.mdx b/mintlify-docs/capability-guides/thermostats/index.mdx index 813f0137d..e43cbe2af 100644 --- a/mintlify-docs/capability-guides/thermostats/index.mdx +++ b/mintlify-docs/capability-guides/thermostats/index.mdx @@ -36,7 +36,7 @@ First, connect your users' thermostats to Seam using the [Seam Console](/core-co Retrieve and monitor your users' thermostats using the [`/thermostats/list`](/api/thermostats/list) and [`/devices/get`](/api/devices/get) endpoints. The Seam API returns robust, up-to-date information about your connected thermostats. In addition, you can use these endpoints to learn the capabilities of each thermostat. -Further, you can use the [`/thermostats/set_temperature_threshold`](/api/thermostats/set_temperature_threshold) endpoint to set upper and lower acceptable temperature bounds. If the thermostat reports a temperature outside this range, Seam emits a [`thermostat.temperature_threshold_exceeded` event](/api/thermostats/events#thermostat.temperature_threshold_exceeded). +Further, you can use the [`/thermostats/set_temperature_threshold`](/api/thermostats/set_temperature_threshold) endpoint to set upper and lower acceptable temperature bounds. If the thermostat reports a temperature outside this range, Seam emits a [`thermostat.temperature_threshold_exceeded` event](/api/thermostats/events#thermostat-temperature_threshold_exceeded). ### Perform Remote Management diff --git a/mintlify-docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.mdx b/mintlify-docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.mdx index cd1a1bf02..14f8e11c3 100644 --- a/mintlify-docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.mdx +++ b/mintlify-docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.mdx @@ -3,7 +3,7 @@ title: 'Setting and Monitoring Temperature Thresholds' description: 'Learn how to use temperature thresholds to monitor your thermostat for potential HVAC system misuse or malfunctioning.' --- -You can configure Seam to emit a [`thermostat.temperature_threshold_exceeded` event](/api/thermostats/events#thermostat.temperature_threshold_exceeded) if a thermostat reports a temperature outside a specific threshold range. This capability helps you to monitor your thermostats proactively, alerting you to potential HVAC system misuse or malfunctioning. +You can configure Seam to emit a [`thermostat.temperature_threshold_exceeded` event](/api/thermostats/events#thermostat-temperature_threshold_exceeded) if a thermostat reports a temperature outside a specific threshold range. This capability helps you to monitor your thermostats proactively, alerting you to potential HVAC system misuse or malfunctioning. Use the [`/thermostats/set_temperature_threshold`](/api/thermostats/set_temperature_threshold) endpoint to set upper and lower acceptable temperature bounds. Then, you can use a [webhook](../../developer-tools/webhooks) to monitor for `thermostat.temperature_threshold_exceeded` events. diff --git a/mintlify-docs/core-concepts/connect-webviews/retrieving-devices-or-access-control-systems-connected-through-a-connect-webview.mdx b/mintlify-docs/core-concepts/connect-webviews/retrieving-devices-or-access-control-systems-connected-through-a-connect-webview.mdx index 612e3a4a2..5464378e2 100644 --- a/mintlify-docs/core-concepts/connect-webviews/retrieving-devices-or-access-control-systems-connected-through-a-connect-webview.mdx +++ b/mintlify-docs/core-concepts/connect-webviews/retrieving-devices-or-access-control-systems-connected-through-a-connect-webview.mdx @@ -3,7 +3,7 @@ title: 'Retrieving Devices or Access Control Systems Connected Through a Connect description: 'Learn how to retrieve the set of devices or ACS that your app user connected to Seam through a specific Connect Webview.' --- -When your app user completes a [Connect Webview](./) authorization flow successfully, the resulting [`connected_account.connected` event](/api/connected_accounts/events#connected_account.connected) includes a `connected_account_id`. Also, once the connection is successful, the [`connect_webview` object](/api/connect_webviews/object) includes the `connected_account_id`. +When your app user completes a [Connect Webview](./) authorization flow successfully, the resulting [`connected_account.connected` event](/api/connected_accounts/events#connected_account-connected) includes a `connected_account_id`. Also, once the connection is successful, the [`connect_webview` object](/api/connect_webviews/object) includes the `connected_account_id`. The first step in controlling connected devices or a connected ACS is to retrieve the newly-connected set of devices or ACS. @@ -17,7 +17,7 @@ Use this `connected_account_id` in a [List Devices](/api/devices/list) command t If you set `wait_for_device_creation` to `false` when [creating the Connect Webview](/core-concepts/connect-webviews/embedding-a-connect-webview-in-your-app#step-1-open-a-connect-webview), you should wait for the [`connected_account.completed_first_sync` - event](/api/connected_accounts/events#connected_account.completed_first_sync) before retrieving the user's + event](/api/connected_accounts/events#connected_account-completed_first_sync) before retrieving the user's devices. This event indicates that Seam has finished the first sync of the connected account and the devices are now available. @@ -173,7 +173,7 @@ Use this `connected_account_id` in a [List ACS Systems](/api/acs/systems/list) c If you set `wait_for_device_creation` to `false` when [creating the Connect Webview](/core-concepts/connect-webviews/embedding-a-connect-webview-in-your-app#step-1-open-a-connect-webview), you should wait for the [`connected_account.completed_first_sync` - event](/api/connected_accounts/events#connected_account.completed_first_sync) before retrieving the user's + event](/api/connected_accounts/events#connected_account-completed_first_sync) before retrieving the user's ACS. This event indicates that Seam has finished the first sync of the connected account and the `acs_system` is now available. diff --git a/mintlify-docs/core-concepts/connect-webviews/verifying-successful-account-connection.mdx b/mintlify-docs/core-concepts/connect-webviews/verifying-successful-account-connection.mdx index 43b6546d8..d104d9e10 100644 --- a/mintlify-docs/core-concepts/connect-webviews/verifying-successful-account-connection.mdx +++ b/mintlify-docs/core-concepts/connect-webviews/verifying-successful-account-connection.mdx @@ -145,7 +145,7 @@ ConnectWebview( ## **Webhook** -When Seam successfully establishes the connection to the user's device or ACS account, Seam emits a [`connected_account.connected` event](/api/connected_accounts/events#connected_account.connected). This event includes a `connect_webview_id` property. +When Seam successfully establishes the connection to the user's device or ACS account, Seam emits a [`connected_account.connected` event](/api/connected_accounts/events#connected_account-connected). This event includes a `connect_webview_id` property. To avoid polling, use a Seam webhook to monitor for a `connected_account.connected` event with a `connect_webview_id` that matches the `connect_webview_id` of the appropriate Connect Webview instance. diff --git a/mintlify-docs/core-concepts/devices/displaying-device-health.mdx b/mintlify-docs/core-concepts/devices/displaying-device-health.mdx index 73fde7878..114478077 100644 --- a/mintlify-docs/core-concepts/devices/displaying-device-health.mdx +++ b/mintlify-docs/core-concepts/devices/displaying-device-health.mdx @@ -101,7 +101,7 @@ Online: True ## Get Device Status Using Connection-Related Events -When a device connection or disconnection occurs, Seam generates a [`device.connected`](/api/devices/events#device.connected) or [`device.disconnected`](/api/devices/events#device.disconnected) event, respectively. You can retrieve these events using a [List Events](/api/events/list) request or through [webhooks](../../developer-tools/webhooks) and then display the corresponding status in your app. +When a device connection or disconnection occurs, Seam generates a [`device.connected`](/api/devices/events#device-connected) or [`device.disconnected`](/api/devices/events#device-disconnected) event, respectively. You can retrieve these events using a [List Events](/api/events/list) request or through [webhooks](../../developer-tools/webhooks) and then display the corresponding status in your app. To help you test your app against events—like device disconnection or @@ -114,7 +114,7 @@ When a device connection or disconnection occurs, Seam generates a [`device.conn ### Get Connection-Related Events Using a List Events Request -When issuing a [List Events](/api/events/list) request to retrieve [`device.connected`](/api/devices/events#device.connected) or [`device.disconnected`](/api/devices/events#device.disconnected) events for a specific device, include the following parameters: +When issuing a [List Events](/api/events/list) request to retrieve [`device.connected`](/api/devices/events#device-connected) or [`device.disconnected`](/api/devices/events#device-disconnected) events for a specific device, include the following parameters:
diff --git a/mintlify-docs/core-concepts/devices/displaying-device-power-status.mdx b/mintlify-docs/core-concepts/devices/displaying-device-power-status.mdx index 63ca461ba..5917d58e4 100644 --- a/mintlify-docs/core-concepts/devices/displaying-device-power-status.mdx +++ b/mintlify-docs/core-concepts/devices/displaying-device-power-status.mdx @@ -235,7 +235,7 @@ You can retrieve these events using a [List Events](/api/events/list) request or ### Get Battery-Related Events Using a List Events Request -When issuing a [List Events](/api/events/list) request to retrieve [`device.low_battery`](/api/devices/events#device.low_battery) or [`device.battery_status_changed`](/api/devices/events#device.battery_status_changed) events for a specific device, include the following parameters: +When issuing a [List Events](/api/events/list) request to retrieve [`device.low_battery`](/api/devices/events#device-low_battery) or [`device.battery_status_changed`](/api/devices/events#device-battery_status_changed) events for a specific device, include the following parameters:
diff --git a/mintlify-docs/device-and-system-integration-guides/33-lock-devices/get-started-with-33-lock-devices.mdx b/mintlify-docs/device-and-system-integration-guides/33-lock-devices/get-started-with-33-lock-devices.mdx index d885d384c..52719dc00 100644 --- a/mintlify-docs/device-and-system-integration-guides/33-lock-devices/get-started-with-33-lock-devices.mdx +++ b/mintlify-docs/device-and-system-integration-guides/33-lock-devices/get-started-with-33-lock-devices.mdx @@ -783,7 +783,7 @@ ActionAttempt( -You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events#lock.unlocked). +You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events#lock-unlocked). To query the `locked` status of the device: diff --git a/mintlify-docs/device-and-system-integration-guides/4suites-locks/get-started-with-4suites-locks.mdx b/mintlify-docs/device-and-system-integration-guides/4suites-locks/get-started-with-4suites-locks.mdx index 9e5e6b44b..b2d774dca 100644 --- a/mintlify-docs/device-and-system-integration-guides/4suites-locks/get-started-with-4suites-locks.mdx +++ b/mintlify-docs/device-and-system-integration-guides/4suites-locks/get-started-with-4suites-locks.mdx @@ -766,7 +766,7 @@ ActionAttempt( -You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events#lock.unlocked). +You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events#lock-unlocked). To query the `locked` status of the device: diff --git a/mintlify-docs/device-and-system-integration-guides/akiles-locks/get-started-with-akiles-locks.mdx b/mintlify-docs/device-and-system-integration-guides/akiles-locks/get-started-with-akiles-locks.mdx index 0a19bde4a..d0b2a3dd3 100644 --- a/mintlify-docs/device-and-system-integration-guides/akiles-locks/get-started-with-akiles-locks.mdx +++ b/mintlify-docs/device-and-system-integration-guides/akiles-locks/get-started-with-akiles-locks.mdx @@ -766,7 +766,7 @@ ActionAttempt( -You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events#lock.unlocked). +You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events#lock-unlocked). To query the `locked` status of the device: diff --git a/mintlify-docs/device-and-system-integration-guides/august-locks/get-started-with-august-locks.mdx b/mintlify-docs/device-and-system-integration-guides/august-locks/get-started-with-august-locks.mdx index 0110b2195..eda9187a0 100644 --- a/mintlify-docs/device-and-system-integration-guides/august-locks/get-started-with-august-locks.mdx +++ b/mintlify-docs/device-and-system-integration-guides/august-locks/get-started-with-august-locks.mdx @@ -798,7 +798,7 @@ ActionAttempt( -You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events#lock.unlocked). +You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events#lock-unlocked). To query the `locked` status of the device: diff --git a/mintlify-docs/device-and-system-integration-guides/ecobee-thermostats/get-started-with-ecobee-thermostats.mdx b/mintlify-docs/device-and-system-integration-guides/ecobee-thermostats/get-started-with-ecobee-thermostats.mdx index 2dd67fdf6..c356345e4 100644 --- a/mintlify-docs/device-and-system-integration-guides/ecobee-thermostats/get-started-with-ecobee-thermostats.mdx +++ b/mintlify-docs/device-and-system-integration-guides/ecobee-thermostats/get-started-with-ecobee-thermostats.mdx @@ -840,7 +840,7 @@ ActionAttempt( -You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/thermostats/events#thermostat.manually_adjusted). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. +You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/thermostats/events#thermostat-manually_adjusted). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. To query `properties.current_climate_setting.hvac_mode_setting` for the device: diff --git a/mintlify-docs/device-and-system-integration-guides/google-nest-thermostats/get-started-with-nest-thermostats.mdx b/mintlify-docs/device-and-system-integration-guides/google-nest-thermostats/get-started-with-nest-thermostats.mdx index d876f9e9b..d712500d8 100644 --- a/mintlify-docs/device-and-system-integration-guides/google-nest-thermostats/get-started-with-nest-thermostats.mdx +++ b/mintlify-docs/device-and-system-integration-guides/google-nest-thermostats/get-started-with-nest-thermostats.mdx @@ -833,7 +833,7 @@ ActionAttempt( -You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/thermostats/events#thermostat.manually_adjusted). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. +You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/thermostats/events#thermostat-manually_adjusted). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. To query `properties.current_climate_setting.hvac_mode_setting` for the device: diff --git a/mintlify-docs/device-and-system-integration-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.mdx b/mintlify-docs/device-and-system-integration-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.mdx index 7468d9611..ba7f169c0 100644 --- a/mintlify-docs/device-and-system-integration-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.mdx +++ b/mintlify-docs/device-and-system-integration-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.mdx @@ -831,7 +831,7 @@ ActionAttempt( -You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/thermostats/events#thermostat.manually_adjusted). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. +You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/thermostats/events#thermostat-manually_adjusted). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. To query `properties.current_climate_setting.hvac_mode_setting` for the device: diff --git a/mintlify-docs/device-and-system-integration-guides/igloohome-locks/index.mdx b/mintlify-docs/device-and-system-integration-guides/igloohome-locks/index.mdx index 7b5e6227c..afbfbb270 100644 --- a/mintlify-docs/device-and-system-integration-guides/igloohome-locks/index.mdx +++ b/mintlify-docs/device-and-system-integration-guides/igloohome-locks/index.mdx @@ -80,11 +80,11 @@ Seam supports the following events and event property values for igloohome devic ### igloohome Auto-Relock -igloohome devices have an auto-relock feature that automatically locks the device after a configurable period of time, for example, 30 seconds. The Seam API reports these auto-relock occurrences by emitting a [`lock.locked` event](/api/locks/events#lock.locked) with `automatic` as the value for the `method` property. +igloohome devices have an auto-relock feature that automatically locks the device after a configurable period of time, for example, 30 seconds. The Seam API reports these auto-relock occurrences by emitting a [`lock.locked` event](/api/locks/events#lock-locked) with `automatic` as the value for the `method` property. ### igloohome Access Denied Event -Each time an igloohome device detects an invalid attempt of entry, Seam emits a [`lock.access_denied` event](/api/locks/events#lock.access_denied). Invalid entry attempts include entering the wrong PIN, exceeding the PIN length, and using an invalid key card. The igloohome lock also flashes red to indicate an invalid attempt. If too many invalid attempts occur, igloohome locks produce a Keypad Security Lockout alarm, accompanied by light and sound indicators. For more information, see the igloohome support articles on [keypad security](https://support.igloohome.co/support/solutions/articles/35000169627-keypad-security-lockout-activated-and-deactivated) and [incorrect PINs](https://support.igloohome.co/support/solutions/articles/35000169625-incorrect-pin). +Each time an igloohome device detects an invalid attempt of entry, Seam emits a [`lock.access_denied` event](/api/locks/events#lock-access_denied). Invalid entry attempts include entering the wrong PIN, exceeding the PIN length, and using an invalid key card. The igloohome lock also flashes red to indicate an invalid attempt. If too many invalid attempts occur, igloohome locks produce a Keypad Security Lockout alarm, accompanied by light and sound indicators. For more information, see the igloohome support articles on [keypad security](https://support.igloohome.co/support/solutions/articles/35000169627-keypad-security-lockout-activated-and-deactivated) and [incorrect PINs](https://support.igloohome.co/support/solutions/articles/35000169625-incorrect-pin). --- diff --git a/mintlify-docs/device-and-system-integration-guides/kwikset-locks/index.mdx b/mintlify-docs/device-and-system-integration-guides/kwikset-locks/index.mdx index c2e5dbfc4..356a09b71 100644 --- a/mintlify-docs/device-and-system-integration-guides/kwikset-locks/index.mdx +++ b/mintlify-docs/device-and-system-integration-guides/kwikset-locks/index.mdx @@ -89,11 +89,11 @@ Seam supports the following events and event property values for Kwikset devices ### Kwikset Auto-Lock -Kwikset devices have an auto-lock feature that automatically locks the device after a configurable period of time, for example, 30 seconds. The Seam API reports these auto-lock occurrences by emitting a [`lock.locked` event](/api/locks/events#lock.locked) with `automatic` as the value for the `method` property. +Kwikset devices have an auto-lock feature that automatically locks the device after a configurable period of time, for example, 30 seconds. The Seam API reports these auto-lock occurrences by emitting a [`lock.locked` event](/api/locks/events#lock-locked) with `automatic` as the value for the `method` property. ### Kwikset Access Denied Event -The Seam API emits a [`lock.access_denied` event](/api/locks/events#lock.access_denied) when an incorrect access code is entered three times in a row on a Kwikset device. The Kwikset device also emits warning beeps for approximately 15 seconds, and the keypad is locked during this time. The keypad remains locked for one minute after the warning beeps end. +The Seam API emits a [`lock.access_denied` event](/api/locks/events#lock-access_denied) when an incorrect access code is entered three times in a row on a Kwikset device. The Kwikset device also emits warning beeps for approximately 15 seconds, and the keypad is locked during this time. The keypad remains locked for one minute after the warning beeps end. --- diff --git a/mintlify-docs/device-and-system-integration-guides/minut-sensors/get-started-with-minut-sensors.mdx b/mintlify-docs/device-and-system-integration-guides/minut-sensors/get-started-with-minut-sensors.mdx index d2da78b05..1f027457d 100644 --- a/mintlify-docs/device-and-system-integration-guides/minut-sensors/get-started-with-minut-sensors.mdx +++ b/mintlify-docs/device-and-system-integration-guides/minut-sensors/get-started-with-minut-sensors.mdx @@ -142,7 +142,7 @@ Navigate to the URL returned by the Webview object. Since you are using a sandbo ### Get the New Webview -After you complete the login above, you'll get an event for [`connected_account.created`](/api/connected_accounts/events#connected_account.created)if you set up a [webhook handler](/developer-tools/webhooks). Otherwise you can just poll for the webview until it's status changes, as shown below: +After you complete the login above, you'll get an event for [`connected_account.created`](/api/connected_accounts/events#connected_account-created)if you set up a [webhook handler](/developer-tools/webhooks). Otherwise you can just poll for the webview until it's status changes, as shown below: diff --git a/mintlify-docs/device-and-system-integration-guides/minut-sensors/index.mdx b/mintlify-docs/device-and-system-integration-guides/minut-sensors/index.mdx index 25d299bbf..51d3ede7e 100644 --- a/mintlify-docs/device-and-system-integration-guides/minut-sensors/index.mdx +++ b/mintlify-docs/device-and-system-integration-guides/minut-sensors/index.mdx @@ -43,7 +43,7 @@ We support the following features: - [Configuring noise threshold settings](/capability-guides/noise-sensors/configure-noise-threshold-settings)\ You can configure a maximum of two noise thresholds per Minut sensor. The first threshold is required and represents the regular threshold for the whole day. The second threshold is optional and represents the threshold for the quiet hours timeframe. - [Receiving noise sensor events when noise events occur](/api/noise_sensors/noise_thresholds/events)\ - For more information, see the [`noise_sensor.noise_threshold_triggered` event](/api/noise_sensors/noise_thresholds/events#noise_sensor.noise_threshold_triggered). + For more information, see the [`noise_sensor.noise_threshold_triggered` event](/api/noise_sensors/noise_thresholds/events#noise_sensor-noise_threshold_triggered). --- diff --git a/mintlify-docs/device-and-system-integration-guides/noiseaware-sensors/get-started-with-noiseaware-sensors.mdx b/mintlify-docs/device-and-system-integration-guides/noiseaware-sensors/get-started-with-noiseaware-sensors.mdx index 3e50dbfca..2027f40bf 100644 --- a/mintlify-docs/device-and-system-integration-guides/noiseaware-sensors/get-started-with-noiseaware-sensors.mdx +++ b/mintlify-docs/device-and-system-integration-guides/noiseaware-sensors/get-started-with-noiseaware-sensors.mdx @@ -152,7 +152,7 @@ Navigate to the URL returned by the Webview object. Since you are using a sandbo ### Get the New Webview -After you complete the login above, you'll get an event for [`connected_account.created`](/api/connected_accounts/events#connected_account.created)if you set up a [webhook handler](/developer-tools/webhooks). Otherwise you can just poll for the webview until it's status changes, as shown below: +After you complete the login above, you'll get an event for [`connected_account.created`](/api/connected_accounts/events#connected_account-created)if you set up a [webhook handler](/developer-tools/webhooks). Otherwise you can just poll for the webview until it's status changes, as shown below: diff --git a/mintlify-docs/device-and-system-integration-guides/noiseaware-sensors/index.mdx b/mintlify-docs/device-and-system-integration-guides/noiseaware-sensors/index.mdx index 864ca5560..522c85014 100644 --- a/mintlify-docs/device-and-system-integration-guides/noiseaware-sensors/index.mdx +++ b/mintlify-docs/device-and-system-integration-guides/noiseaware-sensors/index.mdx @@ -43,7 +43,7 @@ We support the following features: - [Configuring noise threshold settings](/capability-guides/noise-sensors/configure-noise-threshold-settings)\ You can configure a maximum of one noise threshold per hour per Noiseaware sensor. You cannot configure thresholds with time periods that overlap. - [Receiving noise sensor events when noise events occur](/api/noise_sensors/noise_thresholds/events)\ - For more information, see the [`noise_sensor.noise_threshold_triggered` event](/api/noise_sensors/noise_thresholds/events#noise_sensor.noise_threshold_triggered). + For more information, see the [`noise_sensor.noise_threshold_triggered` event](/api/noise_sensors/noise_thresholds/events#noise_sensor-noise_threshold_triggered). --- diff --git a/mintlify-docs/device-and-system-integration-guides/sensi-thermostats/get-started-with-sensi-thermostats.mdx b/mintlify-docs/device-and-system-integration-guides/sensi-thermostats/get-started-with-sensi-thermostats.mdx index dd45ffb5a..4797d1115 100644 --- a/mintlify-docs/device-and-system-integration-guides/sensi-thermostats/get-started-with-sensi-thermostats.mdx +++ b/mintlify-docs/device-and-system-integration-guides/sensi-thermostats/get-started-with-sensi-thermostats.mdx @@ -823,7 +823,7 @@ ActionAttempt( -You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/thermostats/events#thermostat.manually_adjusted). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. +You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/thermostats/events#thermostat-manually_adjusted). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. To query `properties.current_climate_setting.hvac_mode_setting` for the device: diff --git a/mintlify-docs/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.mdx b/mintlify-docs/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.mdx index 06406a002..0f1530c96 100644 --- a/mintlify-docs/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.mdx +++ b/mintlify-docs/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.mdx @@ -788,7 +788,7 @@ ActionAttempt( -You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events#lock.unlocked). +You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events#lock-unlocked). To query the `locked` status of the device: diff --git a/mintlify-docs/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.mdx b/mintlify-docs/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.mdx index 0c8e7c08f..17e79c8b1 100644 --- a/mintlify-docs/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.mdx +++ b/mintlify-docs/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.mdx @@ -834,7 +834,7 @@ ActionAttempt( -You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/thermostats/events#thermostat.manually_adjusted). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. +You can track the status of the operation to confirm that the device was set to heat mode successfully. Query `properties.current_climate_setting.hvac_mode_setting` for the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`thermostat.manually_adjusted` event](/api/thermostats/events#thermostat-manually_adjusted). Further, if you wanted to find out whether the HVAC system was currently heating, you could inspect `properties.is_heating` for the device. To query `properties.current_climate_setting.hvac_mode_setting` for the device: diff --git a/mintlify-docs/device-and-system-integration-guides/ttlock-locks/get-started-with-ttlock-devices.mdx b/mintlify-docs/device-and-system-integration-guides/ttlock-locks/get-started-with-ttlock-devices.mdx index feec2b38f..7c4d8a916 100644 --- a/mintlify-docs/device-and-system-integration-guides/ttlock-locks/get-started-with-ttlock-devices.mdx +++ b/mintlify-docs/device-and-system-integration-guides/ttlock-locks/get-started-with-ttlock-devices.mdx @@ -790,7 +790,7 @@ ActionAttempt( -You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events#lock.unlocked). +You can track the status of the unlock operation to confirm that the device unlocked successfully. Query the `locked` status of the device, [retrieve the action attempt](/api/action_attempts/get) by ID, or look for a [`lock.unlocked` event](/api/locks/events#lock-unlocked). To query the `locked` status of the device: diff --git a/mintlify-docs/low-level-apis/smart-locks/access-codes/index.mdx b/mintlify-docs/low-level-apis/smart-locks/access-codes/index.mdx index 110ffabce..663520ef6 100644 --- a/mintlify-docs/low-level-apis/smart-locks/access-codes/index.mdx +++ b/mintlify-docs/low-level-apis/smart-locks/access-codes/index.mdx @@ -125,7 +125,7 @@ To help your users identify codes set by Seam, Seam provides the name exactly as ## Linking Unlock Events and Access Codes -When a user unlocks a door using an access code, Seam issues a [`lock.unlocked` event](/api/locks/events#lock.unlocked). Some device manufacturers include the ID of the access code in lock-related events. This information is useful for troubleshooting and logging. Further, if you name access codes in a way that identifies the associated users, you can use these `lock.unlocked` events to identify the users who unlocked the doors. +When a user unlocks a door using an access code, Seam issues a [`lock.unlocked` event](/api/locks/events#lock-unlocked). Some device manufacturers include the ID of the access code in lock-related events. This information is useful for troubleshooting and logging. Further, if you name access codes in a way that identifies the associated users, you can use these `lock.unlocked` events to identify the users who unlocked the doors. Currently, the following device manufacturers send the `access_code_id` in the `lock.unlocked` event: From 15629eaece3f19225f4b60a340a35934fb9ae38b Mon Sep 17 00:00:00 2001 From: dawnho Date: Thu, 2 Jul 2026 12:41:36 -0700 Subject: [PATCH 4/4] =?UTF-8?q?fix:=20address=20review=20=E2=80=94=20gener?= =?UTF-8?q?ic=20errors=20link=20+=20fewer=20thermostat-schedule=20links?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - The troubleshooting sentences' generic 'errors or warnings' phrase links to the device errors page, not a specific error (drop #device_offline on all 4 parallel sentences). - Thermostat schedules page: remove the redundant set point and webhook links, keeping the thermostat.temperature_reached_set_point event link. --- .../capability-guides/device-and-system-capabilities.mdx | 2 +- .../thermostats/configure-current-climate-settings.mdx | 2 +- .../thermostats/creating-and-managing-thermostat-schedules.mdx | 2 +- .../smart-locks/access-codes/creating-access-codes/index.mdx | 2 +- mintlify-docs/low-level-apis/smart-locks/lock-and-unlock.mdx | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/mintlify-docs/capability-guides/device-and-system-capabilities.mdx b/mintlify-docs/capability-guides/device-and-system-capabilities.mdx index faf1bf256..b682e9994 100644 --- a/mintlify-docs/capability-guides/device-and-system-capabilities.mdx +++ b/mintlify-docs/capability-guides/device-and-system-capabilities.mdx @@ -21,7 +21,7 @@ All capability flags share the following behavior: - If `true`, the device has this capability, and this capability is functional on this device instance. - If `false`, the device has this capability, but the capability is not currently functional. - See the device [errors and warnings](/api/devices/errors#device_offline) for more details about the cause of this issue. You can also examine the [properties](/api/devices/object) of the device and [events](/api/devices/events) related to the device to learn more about the cause of this issue. + See the device [errors and warnings](/api/devices/errors) for more details about the cause of this issue. You can also examine the [properties](/api/devices/object) of the device and [events](/api/devices/events) related to the device to learn more about the cause of this issue. - If not present, the device does not have this capability. diff --git a/mintlify-docs/capability-guides/thermostats/configure-current-climate-settings.mdx b/mintlify-docs/capability-guides/thermostats/configure-current-climate-settings.mdx index 00c258695..d4d2e974b 100644 --- a/mintlify-docs/capability-guides/thermostats/configure-current-climate-settings.mdx +++ b/mintlify-docs/capability-guides/thermostats/configure-current-climate-settings.mdx @@ -118,7 +118,7 @@ Before you attempt to set the HVAC or fan mode settings for a thermostat, be sur Use the [`/devices/get`](/api/devices/get) endpoint for a specific device to return these capability flags. Then, use an `if` statement or similar check to confirm that the relevant flag is both present and `true` before attempting to perform the imperative thermostat action. -If the relevant capability flag is `false` or not present, you can view the [properties](/api/devices/object) of the device, [errors or warnings](/api/devices/errors#device_offline) for the device, and [events](/api/devices/events) related to the device to learn more about the cause of these issues. For example, you could examine `device.properties.online`. In addition, you could look for a `device.disconnected` event. +If the relevant capability flag is `false` or not present, you can view the [properties](/api/devices/object) of the device, [errors or warnings](/api/devices/errors) for the device, and [events](/api/devices/events) related to the device to learn more about the cause of these issues. For example, you could examine `device.properties.online`. In addition, you could look for a `device.disconnected` event. **Request:** diff --git a/mintlify-docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.mdx b/mintlify-docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.mdx index 494ca2c7b..bf8fd7a8e 100644 --- a/mintlify-docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.mdx +++ b/mintlify-docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.mdx @@ -102,7 +102,7 @@ In the Seam API, use the `starts_at` and `ends_at` parameters to define the time `starts_at` is required and must be unique within all the schedules for the thermostat. However, if you want to schedule a climate preset that starts immediately, set `start_at` to a time in the past. Alternately, you can [activate a climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets/activating-a-climate-preset) immediately. -After a scheduled climate preset starts, Seam emits a [`thermostat.temperature_reached_set_point` event](/api/thermostats/events#thermostat-temperature_reached_set_point) when the thermostat reports a temperature within 1° Celsius of the heating or cooling [set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) specified in this climate preset. You can configure a [webhook](../../developer-tools/webhooks) to watch for this event. +After a scheduled climate preset starts, Seam emits a [`thermostat.temperature_reached_set_point` event](/api/thermostats/events#thermostat-temperature_reached_set_point) when the thermostat reports a temperature within 1° Celsius of the heating or cooling set point specified in this climate preset. You can configure a webhook to watch for this event. --- diff --git a/mintlify-docs/low-level-apis/smart-locks/access-codes/creating-access-codes/index.mdx b/mintlify-docs/low-level-apis/smart-locks/access-codes/creating-access-codes/index.mdx index 17418a002..09bced295 100644 --- a/mintlify-docs/low-level-apis/smart-locks/access-codes/creating-access-codes/index.mdx +++ b/mintlify-docs/low-level-apis/smart-locks/access-codes/creating-access-codes/index.mdx @@ -39,7 +39,7 @@ Before you attempt to create an [online](/low-level-apis/smart-locks/access-code Use [Get Device](/api/devices/get) for a specific device to return these capability flags. Then, use an `if` statement or similar check to confirm that the relevant flag is both present and `true` before attempting to create an access code. -If either of these capability flags is `false` or not present, you can view the [properties](/api/devices/object) of the device, [errors or warnings](/api/devices/errors#device_offline) for the device, and [events](/api/devices/events) related to the device to learn more about the cause of these issues. For example, you could examine the following device properties: +If either of these capability flags is `false` or not present, you can view the [properties](/api/devices/object) of the device, [errors or warnings](/api/devices/errors) for the device, and [events](/api/devices/events) related to the device to learn more about the cause of these issues. For example, you could examine the following device properties: - `device.properties.model.has_built_in_keypad` - `device.properties.model.can_connect_accessory_keypad` diff --git a/mintlify-docs/low-level-apis/smart-locks/lock-and-unlock.mdx b/mintlify-docs/low-level-apis/smart-locks/lock-and-unlock.mdx index db47e8687..169d55839 100644 --- a/mintlify-docs/low-level-apis/smart-locks/lock-and-unlock.mdx +++ b/mintlify-docs/low-level-apis/smart-locks/lock-and-unlock.mdx @@ -24,7 +24,7 @@ Before you attempt to lock or unlock a device, be sure to confirm that your devi Use [Get Device](/api/devices/get) for a specific device to return these capability flags. Then, use an `if` statement or similar check to confirm that the relevant flag is both present and `true` before attempting to lock or unlock the device. -If either of these capability flags is `false` or not present, you can view the [properties](/api/devices/object) of the device, [errors or warnings](/api/devices/errors#device_offline) for the device, and [events](/api/devices/events) related to the device to learn more about the cause of these issues. For example, you could examine `device.properties.online`. In addition, you could look for a `device.disconnected` event. +If either of these capability flags is `false` or not present, you can view the [properties](/api/devices/object) of the device, [errors or warnings](/api/devices/errors) for the device, and [events](/api/devices/events) related to the device to learn more about the cause of these issues. For example, you could examine `device.properties.online`. In addition, you could look for a `device.disconnected` event. **Request:**