> ## Documentation Index
> Fetch the complete documentation index at: https://docs.seam.co/llms.txt
> Use this file to discover all available pages before exploring further.

# The Connect Webview Object

> Learn how the connect_webview object embeds a client-side flow that walks your users through linking their device or system accounts to Seam.

## The connect\_webview Object

Represents a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews).

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 or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system 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 or systems using the Seam API.

Connect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each 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 or system account to Seam through your app, first create a `connect_webview`. Once created, this `connect_webview` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.

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.

To list all providers within a category, use `/devices/list_device_providers` with the desired `provider_category` filter. To list all provider keys, use `/devices/list_device_providers` with no filters.

<ResponseExample>
  ```json Connect Webview theme={null}
  {
    "accepted_capabilities": [
      "lock",
      "thermostat"
    ],
    "accepted_devices": [],
    "accepted_providers": [
      "schlage",
      "kwikset",
      "yale",
      "smartthings"
    ],
    "any_device_allowed": false,
    "any_provider_allowed": false,
    "authorized_at": "2025-06-14T16:54:17.946323Z",
    "automatically_manage_new_devices": true,
    "connect_webview_id": "c4c30885-ec87-4b31-8d7b-9bc0678fa028",
    "connected_account_id": "5d2fe05f-4f5b-4b91-909c-96e2601dccbe",
    "created_at": "2025-06-14T16:54:17.946323Z",
    "custom_metadata": {
      "id": "internalId1"
    },
    "custom_redirect_failure_url": "https://example.com/failure-redirect",
    "custom_redirect_url": "https://example.com/redirect",
    "device_selection_mode": "single",
    "login_successful": true,
    "selected_provider": "schlage",
    "status": "authorized",
    "url": "https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-1234-1234-1234-123456789012&auth_token=2r2Rn8V5QUtxE79gNsTmLK58KkuqrwU8d",
    "wait_for_device_creation": true,
    "workspace_id": "9db95105-e77d-4577-b1b7-0a20b360d5e0"
  }
  ```
</ResponseExample>

***

## Properties

<ResponseField name="accepted_capabilities" type="Array">
  High-level device capabilities that the Connect Webview can accept. When creating a Connect Webview, you can specify the types of devices that it can connect to Seam. If you do not set custom `accepted_capabilities`, Seam uses a default set of `accepted_capabilities` for each provider. For example, if you create a Connect Webview that accepts SmartThing devices, without specifying `accepted_capabilities`, Seam accepts only SmartThings locks. To connect SmartThings thermostats and locks to Seam, create a Connect Webview and include both `thermostat` and `lock` in the `accepted_capabilities`.
</ResponseField>

<ResponseField name="accepted_providers" type="Array">
  List of accepted [provider keys](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).
</ResponseField>

<ResponseField name="any_provider_allowed" type="Boolean">
  Indicates whether any provider is allowed.
</ResponseField>

<ResponseField name="authorized_at" type="String (ISO 8601)">
  Date and time at which the user authorized (through the Connect Webview) the management of their devices.
</ResponseField>

<ResponseField name="automatically_manage_new_devices" type="Boolean">
  Indicates whether Seam should [import all new devices](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API.
</ResponseField>

<ResponseField name="connect_webview_id" type="String (UUID)">
  ID of the Connect Webview.
</ResponseField>

<ResponseField name="connected_account_id" type="String (UUID)">
  ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the Connect Webview.
</ResponseField>

<ResponseField name="created_at" type="String (ISO 8601)">
  Date and time at which the Connect Webview was created.
</ResponseField>

<ResponseField name="custom_metadata" type="object">
  Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.
</ResponseField>

<ResponseField name="custom_redirect_failure_url" type="String">
  URL to which the Connect Webview should redirect when an unexpected error occurs.
</ResponseField>

<ResponseField name="custom_redirect_url" type="String">
  URL to which the Connect Webview should redirect when the user successfully pairs a device or system. If you do not set the `custom_redirect_failure_url`, the Connect Webview redirects to the `custom_redirect_url` when an unexpected error occurs.
</ResponseField>

<ResponseField name="customer_key" type="String">
  The customer key associated with this webview, if any.
</ResponseField>

<ResponseField name="device_selection_mode" type="Enum (String)">
  The device selection mode.
</ResponseField>

<ResponseField name="login_successful" type="Boolean">
  Indicates whether the user logged in successfully using the Connect Webview.
</ResponseField>

<ResponseField name="selected_provider" type="String">
  Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).
</ResponseField>

<ResponseField name="status" type="Enum (String)">
  Status of the Connect Webview. `authorized` indicates that the user has successfully logged into their device or system account, thereby completing the Connect Webview.
</ResponseField>

<ResponseField name="url" type="String">
  URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user.
</ResponseField>

<ResponseField name="wait_for_device_creation" type="Boolean">
  Indicates whether Seam should [finish syncing all devices](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview.
</ResponseField>

<ResponseField name="workspace_id" type="String (UUID)">
  ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the Connect Webview.
</ResponseField>