Comment on page
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_id | uuid | ID of the Connect Webview |
accepted_providers | string[] | |
selected_provider | string | |
custom_metadata | object, optional | Specify up to 50 keys, with key names up to 40 characters long. Use any non-object value. Strings are limited to 500 characters. |
custom_redirect_url | string, optional | If set, the Connect Webview will redirect to this url when the user successfully pairs a device, or runs into an unexpected error. |
custom_redirect_failure_url | string, optional | If set, the Connect Webview will redirect to this url when an unexpected error occurs. |
status | string | pending or authorized |
url | string | URL to the webview |
login_successful | boolean | Whether the user logged in successfully using the webview |
connected_account_id | uuid | ID of the Connected Account that was created after the user successfully logged in |
key | Description |
|---|---|
stable | Only returns provider integration marked as stable. |
Brand Name | Device Provider Key | Device Features Supported |
|---|---|---|
my_2n | ||
four_suites | ||
akuvox | ||
august | ||
avigilon_alta | ||
brivo | ||
controlbyweb | ||
doorking | ||
dormakaba_oracode | ||
ecobee | ||
genie | ||
hubitat | ||
igloohome | ||
kwikset | ||
linear | ||
lockly | ||
minut | ||
nest | ||
noiseaware | ||
nuki | ||
pti | ||
salto | ||
schlage | ||
smartthings | ||
ttlock | ||
wyze | ||
yale |
You can perform the following actions on
connect_webview objects:Last modified 4d ago