Connect Webviews
Use Connect Webviews to connect to your users' smart devices to the Seam API
The connect_webview object represents a Connect Webview. Connect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices using the Seam API.
Connect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each device brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.
To enable a user to connect their device account to Seam through your app, you must first create a connect_webview. Once created, this connect_webview includes a URL that you can use to open an iframe or new window containing the Connect Webview for your user.
connect_webview Properties
connect_webview Properties
| String (UUID) | ID of the Connect Webview |
| Array of strings | List of accepted device provider keys |
| Array of strings | List of accepted devices |
| Boolean | Indicates whether any provider is allowed |
| Boolean | Indicates whether any device is allowed |
| String | Selected provider of the Connect Webview, one of device provider keys |
| String (enum) | Device selection mode, including |
| JSON object Optional | A set of up to 50 keys, with key names up to 40 characters long. Accepts string or Boolean values. Strings are limited to 500 characters For more information, see Attaching Custom Data to the Connect Webview. |
| Boolean | Indicates whether Seam should import all new devices for the connected account to make these devices available for use and management by the Seam API |
| Boolean | Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview |
| String Optional | If set, the Connect Webview redirects to this URL when the user successfully pairs a device or, if the |
| String Optional | If set, the Connect Webview redirects to this URL when an unexpected error occurs |
| String |
|
| String | URL to the webview |
| Boolean | Indicates whether the user logged in successfully using the Connect Webview |
| String (UUID) | ID of the Connected Account that was created after the user successfully logged in |
| String | Date and time at which the Connect Webview was created |
| String | Date and time at which the user authorized (through the Connect Webview) the management of their devices |
| String (UUID) | ID of the workspace that contains the Connect Webview |
Accepted Provider Category Keys
| key | Description |
|---|---|
| Only returns provider integrations marked as stable. |
| Only returns provider integrations marked as consumer smart locks. |
| Only returns provider integrations marked as thermostats. |
| Only returns provider instegrations marked as noise sensors. |
To list all providers within a category, use the List Device Providers method with the desired provider_category filter.
Device Provider Keys
| Brand Name | Device Provider Key | Device Features Supported |
|---|---|---|
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
|
connect_webview Methods
connect_webview MethodsYou can perform the following actions on connect_webview objects:
Last updated
