Connect Webviews

Use Connect Webview to connect to your users' smart devices with the Seam API

Introduction to Connect Webview

Connect Webview is a component that your users will interact with in order to link their smart devices to Seam and allow you to access their devices via the Seam API.

Seam Connect Webview will handle credential validation, multi-factor authentication, and error handling for each device type that we support.

To allow a user to sign in, you need to create a connect_webview . After creating the webview, you'll receive a URL that you can use to open an iframe or new window containing a login page for your user.

The Connect Webview Object

connect_webview_id	uuid	ID of the Connect Webview
accepted_providers	string[]	List of accepted device providers keys
selected_provider	string	Selected provider of the webview, one of device providers keys
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

Device Provider Keys

Brand Name	Device Provider Key	Device Features supported
August Home	august	Access Codes, Locks
Noiseaware	noiseaware	Noise Detection
Schlage Connect	schlage	Access Codes, Locks
SmartThings	smartthings	Access Codes, Locks
ButterflyMX	butterflymx	Locks
Genie Aladdin Connect	genie	Locks
Salto	salto	Access Codes, Locks
Yale	yale_access	Access Codes, Locks
Brivo	brivo	Locks
Akuvox	akuvox	Access Codes, Locks
DoorKing	doorking	Remote Unlock
Linear	linear	Access Codes, Remote Unlock
Minut	minut	Noise Detection

List of Methods

Create a Connect Webview	Create a Connect Webview
List Connect Webviews	List Connect Webviews
Checking a Connect Webview	Checking a Connect Webview
Delete Webview	Delete Webview
View Connect Webview	View Connect Webview