2. Configure Embed

Embed Creation: a comprehensive guide

Create Embed Configuration

On the page with Embed Configurations you can create a new Configuration and manage the existing ones:

Configurations page

To create a new Embed:

1. Click the Add button in the top left corner. The Embed creation dialog will then appear:

   

   Create Embed dialog
2. Specify the following fields:

   • Name - This is an internal name used only for your reference.

   • Allowed domains - You can enter one or more domains where the iframe will be allowed to be displayed. If you enter multiple domains, separate them by commas. Wildcard with * are also allowed (e.g. *.example.com).

   • Custom CSS - CSS rules used to customize the iframe for an End User

   • Proprietary connector - Your own connector or another connector of which you already have the credentials for all your end users, so that your users don't have to fill it in (more details) - Optional

   • Sharing level - Whether flows and connector auth are shared on a per-user or a per-account basis (more details)

   • Ask for consent - Whether your end users should be asked for consent (for GDPR compliance) when they open the iframe for the first time (more details) - Optional

3. Сlicking Submit to save Embed Configuration. Its secret token and iframe code will be generated. You can see both by clicking on the edit button of the new Embed in the list of Embed Configurations:

   

   The secret token (needed for JWT) and the iframe code - ready to be copy and pasted to your app
4. Finish setup. Depending on the Embed version, the process is slightly different

Embed V1

Steps to Configure Embed V1

• Access the Groups Section:

  • In the Embed Configuration, select Groups.

  • Groups allow you to organize integrations (Flows) into groups for end users in the iframe

Embed V1

• Add a Group:

  • On the Groups page, click Add

  • In the dialog box, specify

    • Name: This is the name of the group displayed in the iframe.

    • Highlighted Connectors (Optional): Select Connectors to display their logos on the group in the iframe

    • Sharing settings (Optional): Assign specific users or teams the ability to view or run the integrations.

Create / Edit Group dialog

• Add Flows to the Group:

  • Open the newly created Group

  • Click Flows

  • Add the desired Flow that will be available for the end user

Embed V2

Steps to Configure Embed V2

• Access the Partners Section:

  • In the Embed Configuration, select Partners

    

    Embed V2
• Add a Partner:

  • On the Partners page, click Add

  • In the dialog box, specify

    • Partner: The partner's logo visible in the iframe

    • Category: Category name visible in the iframe

    • Sharing settings (Optional): Assign specific users or teams the ability to view or run the integrations.

  

  Create / Edit Partner modal
• Navigate to Use Cases:

  • Press Use Cases

  • On the Use Cases page, click Add

  • A dialog box will appear

    

    Create / Edit Use Case modal
• Add Flows to the Use Case:

  • Open the newly created Use Case

  • Click Flows

  • Add the desired Flow that will be available for the end user