embed-connections.mdx•3.08 kB
---
title: "Create/Update Connections"
description: ""
icon: "cards"
---
<Info>
**Requirements:**
* Activepieces version 0.34.5 or higher
* SDK version 0.3.2 or higher
</Info>
<Snippet file="replace-oauth2-apps.mdx" />
<Info>
"connectionName" is the externalId of the connection (you can get it by hovering the connection name in the connections table). <br />
We kept the same parameter name for backward compatibility, anyone upgrading their instance from < 0.35.1, will not face issues in that regard.
</Info>
<Warning>
**Breaking Change:** <br/><br/> If your Activepieces instance version is < 0.45.0 and (you are using the connect method from the embed sdk, and need the connection externalId to be returned after the user creates it OR if you want to reconnect a specific connection with an externalId), you must upgrade your instance to >= 0.45.0
</Warning>
- You can use the embedded SDK in your SaaS to allow your users to create connections and store them in Activepieces.
<Steps>
<Step title="Initialize the SDK">
Follow the instructions in the [Embed Builder](./embed-builder).
</Step>
<Step title="Call Connect Method">
After initializing the SDK, you will have access to a property called `activepieces` inside your `window` object. Call its `connect` method to open a new connection dialog as follows.
```html
<script>
activepieces.connect({pieceName:'@activepieces/piece-google-sheets'});
</script>
```
**Connect Parameters:**
| Parameter Name | Required | Type | Description |
| -------------- | -------- | ------ | ------------------------------------------- |
| pieceName | ✅ | string | The name of the piece you want to create a connection for.
| connectionName | ❌ | string | The external Id of the connection (you can get it by hovering the connection name in the connections table), when provided the connection created/upserted will use this as the external Id and display name.
| newWindow | ❌ | \{ width?: number, height?: number, top?: number, left?: number \} | If set the connection dialog will be opened in a new window instead of an iframe taking the full page.
**Connect Result**
The `connect` method returns a `promise` that resolves to the following:
```ts
{
connection?: {
id: string,
name: string
}
}
```
<Info>
`name` is the externalId of the connection.
`connection` is undefined if the user closes the dialog and doesn't create a connection.
</Info>
<Tip>
You can use the `connections` piece in the builder to retrieve the created connection using its name.
</Tip>
</Step>
</Steps>