Skip to content

EmbedSurfaceOptions

Options for Platform.embedSurface.

mount: HTMLElement;

Host element the nested surface iframe is mounted into (inline in your UI).


optional params?: Record<string, unknown>;

Initial params scoping the surface; structured-clone-serializable.


providerId: string;

The app that provides the surface (e.g. "billing").


surfaceName: string;

The provider’s declared surface name (e.g. "invoice-list").