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:

To create a new Embed click the Add button in the top left corner. The Embed creation dialog will then appear:

There you need to 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).

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

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

  • 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

  • Groups - the way to organize integrations (Flows) in groups for the end users in iframe

    • Group name - This is the name of the group that will be displayed in the iframe.

    • Highlighted connectors - The selected Connectors' logos will be displayed on the group in the iframe. - Optional

    • Flows - The list of Flows to be available for the end user. To add a Flow, you should enter the Flow ID.

You can add more Groups and Flows by clicking the corresponding buttons.

After clicking Submit, the Embed Configuration will be saved and 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:

Last updated