Embedding is available on our enterprise plan. Talk to sales and we'll help you scope it.
Configure SDK
Adding the embedding SDK script will initialize an object in your window calledactivepieces, which has a method called configure that you should call after the container has been rendered.
The following scripts shouldn’t contain the
async or defer attributes.These steps assume you have already generated a JWT token from the backend. If not, please check the provision-users page.
<script src="https://cdn.activepieces.com/sdk/embed/0.13.0.js">
</script>
<script>
const instanceUrl = 'YOUR_INSTANCE_URL';
const jwtToken = 'GENERATED_JWT_TOKEN';
const containerId = 'YOUR_CONTAINER_ID';
activepieces.configure({
instanceUrl,
jwtToken,
prefix: "/",
embedding: {
containerId,
builder: {
disableNavigation: false,
hideFlowName: false
},
dashboard: {
hideSidebar: false
},
hideFolders: false,
navigation: {
handler: ({ route }) => {
// The iframe route has changed, make sure you check the navigation section.
}
}
},
});
</script>
configure returns a promise which is resolved after authentication is done.Please check the navigation section, as it’s very important to understand how navigation works and how to supply an auto-sync experience.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| instanceUrl | ✅ | string | The url of the instance hosting Activepieces, could be https://cloud.activepieces.com if you are a cloud user. |
| jwtToken | ✅ | string | The jwt token you generated to authenticate your users to Activepieces. |
| prefix | ❌ | string | Some customers have an embedding prefix, like this <embedding_url_prefix>/<Activepieces_url>. For example if the prefix is /automation and the Activepieces url is /flows the full url would be /automation/flows. |
| embedding.containerId | ❌ | string | The html element’s id that is going to be containing Activepieces’s iframe. |
| embedding.initialRoute | ❌ | string | The route the iframe loads on, instead of the default page (added in 0.14.0). Accepts the same routes as the navigate method. |
| embedding.builder.disableNavigation | ❌ | boolean | keep_home_button_only | Hides the folder name, home button (if not set to keep_home_button_only) and delete option in the builder, by default it is false. |
| embedding.builder.hideFlowName | ❌ | boolean | Hides the flow name and flow actions dropdown in the builder’s header, by default it is false. |
| embedding.builder.homeButtonClickedHandler | ❌ | ()=>void | Callback that stops home button from navigating to dashboard and overrides it with this handler (added in 0.4.0) |
| embedding.builder.homeButtonIcon | ❌ | logo | back | if set to back the tooltip shown on hovering the home button is removed (added in 0.5.0) |
| embedding.dashboard.hideSidebar | ❌ | boolean | Controls the visibility of the sidebar in the dashboard, by default it is false. |
| embedding.dashboard.hideFlowsPageNavbar | ❌ | boolean | Controls the visibility of the navbar showing flows,issues and runs above the flows table in the dashboard, by default it is false. (added in 0.6.0) |
| embedding.dashboard.hidePageHeader | ❌ | boolean | Hides the page header in the dashboard by default it is false. (added in 0.8.0) |
| embedding.hideFolders | ❌ | boolean | Hides all things related to folders in both the flows table and builder by default it is false. |
| embedding.hideTables | ❌ | boolean | Hides the Tables UI in the dashboard (tree, filters, create/import buttons) and blocks direct access to the table editor route. The Tables piece used inside flows is unaffected. By default it is false. (added in 0.9.0) |
| embedding.hideActiveUsers | ❌ | boolean | Hides the active users (presence) avatars in the builder’s header and the table editor’s header. When hidden, the embedded user also stops appearing in other collaborators’ active-users list. By default it is false. (added in 0.12.0) |
| embedding.hideGlobalSearch | ❌ | boolean | Hides the global search button in the dashboard sidebar and disables the CMD+K / Ctrl+K command palette, by default it is false. (added in 0.13.0) |
| embedding.formulasDocsUrl | ❌ | string | Where the “See All” link in the formula editor points. Leave it unset (the default) and the link is hidden entirely, so embedded users are never sent to the Activepieces docs. Set it to your own formula reference to show the link pointing there. (added in 0.15.0) |
| embedding.analytics.gtmContainerId | ❌ | string | Loads Google Tag Manager inside the embedded app using this container id (e.g. GTM-XXXXXXX), so the tags you configure in GTM (analytics, session recording) run on the builder and dashboard. Scripts on your own page cannot see into the iframe, so this is the only way to track it. Off when unset. (added in 0.16.0) |
| embedding.analytics.clarityProjectId | ❌ | string | Loads Microsoft Clarity inside the embedded app using this project id. Session recording on a large flow canvas can be heavy, so test it on a real flow before rolling out. Off when unset. (added in 0.16.0) |
| embedding.styling.fontUrl | ❌ | string | The url of the font to be used in the embedding, by default it is https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500;700&display=swap. |
| embedding.styling.fontFamily | ❌ | string | The font family to be used in the embedding, by default it is Roboto. |
| embedding.styling.mode | ❌ | light | dark | Controls light/dark mode (added in 0.5.0) |
| embedding.hideExportAndImportFlow | ❌ | boolean | Hides the option to export or import flows (added in 0.4.0) |
| embedding.hideDuplicateFlow | ❌ | boolean | Hides the option to duplicate a flow (added in 0.5.0) |
| embedding.locale | ❌ | en | nl | de | fr | es | ja | zh | pt | zh-TW | ru | | it takes ISO 639-1 locale codes (added in 0.5.0) |
| navigation.handler | ❌ | ({route:string}) => void | This callback will be triggered each time a route in Activepieces changes, you can read more about it here |
For the font to be loaded, you need to set both the
fontUrl and fontFamily properties.
If you only set one of them, the default font will be used.
The default font is Roboto.
The font weights we use are the default font-weights from tailwind.Before enabling
embedding.analytics: the GTM container and Clarity tag run inside the embedded app with your user’s session, so any tag you publish can read what that user can. Clarity masks input fields by default but records everything else on screen, including step outputs, sample data, and connection names in the builder. You own the consent banner and privacy disclosure for that data. Session recording also mirrors the page in memory, so test it on your largest flows before rolling it out widely.