Attaching Custom Metadata to the Connect Webview

Use custom metadata to link internal IDs from your application to a Seam Connect Webview and connected account.

Adding Custom Metadata to a Connect Webview enables you to store custom information, like customer details or internal IDs from your application. The custom_metadata is then transferred to any connected accounts connected via the connect webview, making it easy to find and filter these resources in your Seam workspace.

The custom_metadata property supports up to 50 JSON key:value pairs. Upon an account is successfully connected via a connect webview, Seam creates a connected account and copies the custom_metadata to it.

If the custom_metadata property is left blank, Seam will store an empty set ({}) on both the connect webview and connected account resource.

To add custom_metadata to a Connect Webview:

1. Execute /connect_webviews/create and specify the internal ID as a key:value pair in the custom_metadata. For example:

Python

Request:

seam.connect_webviews.create(
  provider_category = "stable",
  custom_metadata = {
    "your_app_user_id": "xxxx" # Insert your custom data here.
  }
)

Response:

ConnectWebview(
  workspace_id='398d80b7-3f96-47c2-b85a-6f8ba21d07be',
  connect_webview_id='49e050d9-cb4c-4600-b24d-cdf9dd2f92b7',
  status='pending',
  url='https://connect.getseam.com/connect_webviews/view?connect_webview_id=49e050d9-cb4c-4600-b24d-cdf9dd2f92b7&auth_token=C1r8ff3GLSr2L1ifEaCopAgrq2Faht2Dh',
  custom_metadata={'id': 'internal_id_1'},
  ...
)

cURL (bash)

Request:

curl -X 'POST' \
  'https://connect.getseam.com/connect_webviews/create' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer ${API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "provider_category": "stable",
  "custom_metadata": {
    "your_app_user_id": "xxxx"
  }
}'

Response:

{
  "connect_webview": {
    "url": "https://connect.getseam.com/connect_webviews/view?connect_webview_id=3c3f4c15-e7db-47c6-bc5a-1bf206ff269c&auth_token=LrpMC4MVHAY8YJRcNFeX1nQcb7tGNwpot",
    "status": "pending",
    "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
    "custom_metadata": {
      "id": "internal_id_1"
    },
    ...
  },
  "ok": true
}

JavaScript

Request:

await seam.connectWebviews.create({
  provider_category: "stable",
  custom_metadata: {
    "your_app_user_id": "xxxx" // Insert your custom data here.
  }
})

Response:

{
  url: 'https://connect.getseam.com/connect_webviews/view?connect_webview_id=3937fa0b-ab09-4a00-9f10-69864750ed07&auth_token=PVHmtzULRFEQDny776KDsegSQ5t2SsZHR',
  status: 'pending',
  workspace_id: '398d80b7-3f96-47c2-b85a-6f8ba21d07be',
  custom_metadata: { id: 'internalId1' },
  ...
}

Ruby

Request:

client.connect_webviews.create(
  provider_category: "stable",
  custom_metadata: {
    "your_app_user_id": "xxxx" # Insert your custom data here.
  }
)

Response:

<Seam::ConnectWebview:0x00438
  url="https://connect.getseam.com/connect_webviews/view?connect_webview_id=7fe89a3e-a1d7-44dd-b53f-35f8f5f92607&auth_token=3jJWKRBcJvZeGcrA8UnC1y2RieyHDPSwV"
  status="pending"
  workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be"
  custom_metadata={"id"=>"internal_id_1"}
  ...
>

C#

Request:

var customMetadata = new Dictionary<string, string>()
{
  {"id", "internal-user-id"}
};

seam.ConnectWebviews.Create(
  providerCategory: Seam.Api.ConnectWebviews.CreateRequest.ProviderCategoryEnum.Stable,
  customMetadata: customMetadata
);

Response:

{
  "connect_webview_id": "3874d8b4-4bb5-470a-9fc7-a54931a4b933",
  "url": "https://connect.getseam.com/connect_webviews/view?connect_webview_id=3874d8b4-4bb5-470a-9fc7-a54931a4b933&auth_token=F9t4SkQ6R8mZjJEBV5K4dwoVdkR6VtjdJ",
  "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
  "custom_metadata": {
    "id": "user1"
  },
  ...
}

Java

Request:

Map<String, CustomMetadataValue> customMetadata =
    Map.of("id", CustomMetadataValue.of(Optional.of("internalId1")));

seam.connectWebviews().create(ConnectWebviewsCreateRequest.builder()
    .providerCategory(ProviderCategory.STABLE)
    .customMetadata(customMetadata)
    .build());

Response:

{
  "connect_webview_id" : "72dffd65-71e0-4035-9c85-199dd756a11c",
  "url" : "https://connect.getseam.com/connect_webviews/view?connect_webview_id=72dffd65-71e0-4035-9c85-199dd756a11c&auth_token=FQea1nN2sMGwLVRsjQXajzNzvven6jbGX",
  "workspace_id" : "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
  "device_selection_mode" : "none",
  "accepted_providers" : [ "august", "avigilon_alta", "brivo", "schlage", "smartthings", "yale", "nuki", "salto", "controlbyweb", "minut", "my_2n", "kwikset", "ttlock", "noiseaware", "igloohome", "ecobee", "four_suites", "dormakaba_oracode", "lockly", "wyze" ],
  "any_provider_allowed" : false,
  "any_device_allowed" : false,
  "created_at" : "2023-11-16T22:53:57.515Z",
  "login_successful" : false,
  "status" : "pending",
  "custom_redirect_url" : null,
  "wait_for_device_creation" : false,
  "custom_redirect_failure_url" : null,
  "automatically_manage_new_devices" : true,
  "authorized_at" : null,
  "custom_metadata" : {
    "id" : "internalId1"
  },
  "selected_provider" : null
}

2. Your app presents the Connect Webview to your user.

3. The user completes the Connect Webview.

4. Seam creates a connected account containing the user's device account information. This connected account includes a custom_metadata property that automatically contains the information that you set in the custom_metadata property for the Connect Webview.

5. To retrieve the ID of the connected account associated with the completed Connect Webview, get the connect_webview and check the connected_account_id property.

6. To retrieve the connected account, get the connected_account with the ID that you identified in the previous step.

7. Within the returned connected_account, view the custom_metadata.

If a Connect Webview was used to connect an existing connected account (for example, to reconnect a disconnected account), Seam will replace any existing custom metadata in the connected_account object with the new payload.

Next Steps

Once you have attached custom metadata to Connect Webviews, you can filter your Connect Webviews by this custom metadata.