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 through the connect webview, making it easy to find and filter these resources in your Seam workspace.

You can also use unique resource keys as an easy way to link your resources to Seam resources. For details, see Mapping Your Resources to Seam Resources.

The custom_metadata property supports up to 50 JSON key:value pairs. When an account is successfully connected through a Connect Webview, Seam creates a connected account and copies the custom_metadata to it.

If the custom_metadata property is left blank, Seam stores 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:

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' },
  ...
}

cURL

Python

Ruby

C#

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

2. The user completes the Connect Webview.

3. 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.

4. 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.

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

6. 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.