From 51fb9171fe396315807fb7db158eb19324d001ed Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 17 Aug 2026 16:09:06 +0000 Subject: [PATCH 1/2] docs: clarify InstallIntegration manage and uninstall states --- src/embeddable-ui-components.mdx | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/src/embeddable-ui-components.mdx b/src/embeddable-ui-components.mdx index 2f55463e..665533e3 100644 --- a/src/embeddable-ui-components.mdx +++ b/src/embeddable-ui-components.mdx @@ -92,6 +92,17 @@ The `getToken` function should return a promise that resolves to a valid JWT tok The `InstallIntegration` component prompts your customer for their SaaS credentials, and then guides them through the installation flow for an integration. If they've already installed this integration, then the component will display the current configuration of the integration and allow them to update it. +#### Install, manage, and uninstall states + +The component renders one of two states based on whether an installation already exists for the current `groupRef` and `integration`: + +* **Not installed:** Shows the connect and configure flow. When the consumer finishes, the `onInstallSuccess` callback fires with the new `installationId` and `Config`. +* **Already installed:** Shows the manage view with the current configuration. From here, the consumer can update objects, fields, and mappings, or uninstall the integration. + * Saving configuration changes fires `onUpdateSuccess` with the `installationId` and updated `Config`. + * Uninstalling removes the installation and its configuration, fires `onUninstallSuccess` with the `installationId`, and returns the component to the not-installed state so the consumer can install again. + +You render the same `InstallIntegration` component in both states — you do not need a separate component or route for the manage or uninstall flow. + Please note that each [group](/terminology#group) is able to install the integration once, so if someone else with the same `groupRef` has already installed the integration, then the user will not be able to install the same integration again. The parameters of the component are: From fdb8b9110802219fa08194128215cfd1d6b82c8c Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 17 Aug 2026 16:09:58 +0000 Subject: [PATCH 2/2] docs: add SEO description to prebuilt UI components page --- src/embeddable-ui-components.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/src/embeddable-ui-components.mdx b/src/embeddable-ui-components.mdx index 665533e3..28273ea8 100644 --- a/src/embeddable-ui-components.mdx +++ b/src/embeddable-ui-components.mdx @@ -1,5 +1,6 @@ --- title: "Prebuilt UI components" +description: "Embed Ampersand's React components to let customers connect SaaS accounts, configure integrations, and manage or uninstall existing installations." --- ## Project setup