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_id	String (UUID)	ID of the Connect Webview
accepted_providers	Array of strings	List of accepted device provider keys
accepted_devices	Array of strings	List of accepted devices
any_provider_allowed	Boolean	Indicates whether any provider is allowed
any_device_allowed	Boolean	Indicates whether any device is allowed
selected_provider	String	Selected provider of the Connect Webview, one of device provider keys
custom_metadata	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.
automatically_manage_new_devices	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
wait_for_device_creation	Boolean	Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview
custom_redirect_url	String Optional	If set, the Connect Webview redirects to this URL when the user successfully pairs a device or, if the custom_redirect_failure_url is not set, when an unexpected error occurs
custom_redirect_failure_url	String Optional	If set, the Connect Webview redirects to this URL when an unexpected error occurs
status	String	pending or authorized
url	String	URL to the webview
login_successful	Boolean	Indicates whether the user logged in successfully using the Connect Webview
connected_account_id	String (UUID)	ID of the Connected Account that was created after the user successfully logged in
created_at	String	Date and time at which the Connect Webview was created
authorized_at	String	Date and time at which the user authorized (through the Connect Webview) the management of their devices
workspace_id	String (UUID)	ID of the workspace that contains the Connect Webview

Provider Category Keys

When you create a Connect Webview, specify the desired provider category key in the provider_category parameter. Alternately, to specify a list of providers explicitly, use the accepted_providers parameter with a list of device provider keys.

key	Description
stable	Only returns provider integrations marked as stable.
consumer_smartlocks	Only returns provider integrations marked as consumer smart locks.
thermostats	Only returns provider integrations marked as thermostats.
noise_sensors	Only returns provider integrations 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

To list all provider keys, use the List Device Providers method with no filters.

Provider Name	Device Provider Key
2N	my_2n
4SUITES	four_suites
Akiles	akiles
Akuvox	akuvox
ASSA ABLOY Credential Service	assa_abloy_credential_service
ASSA ABLOY Visionline Access Control System	visionline
August Home	august
Avigilon Alta	avigilon_alta
Brivo	brivo
ControlByWeb	controlbyweb
DoorKing	doorking
dormakaba Oracode	dormakaba_oracode
ecobee	ecobee
Genie Aladdin Connect	genie
Honeywell Resideo	honeywell_resideo
igloohome	igloohome
Kwikset	kwikset
Latch	latch
Linear	linear
Lockly	lockly
Minut	minut
Nest	google_nest
NoiseAware	noiseaware
Nuki	nuki
PTI Storlogix Cloud	pti
Salto KS ACS and Salto KS Locks	salto
Schlage	schlage
SmartThings	smartthings
Tedee	tedee
TTLock	ttlock
Wyze	wyze
Yale	yale

connect_webview Methods

You can perform the following actions on connect_webview objects:

• Create a Connect Webview

• List Connect Webviews

• Get a Connect Webview

• Check a Connect Webview

• Delete a Connect Webview