1.1 Creating Embed Flows
Embed Flows: essential features and best practices
Last updated
Embed Flows: essential features and best practices
Last updated
In general, you create a Flow for Embed (Embed Flow) just as you would for a normal Flow. However, there are several features you should keep in mind while creating a Flow for Embed. All of them are described below.
The specific Connector Auts (login) details will be provided by your end users when they configure Embed on the page of your application. Make sure to leave Connector Auths empty for all Connectors in the Flow, where you need to get log in data from a user.
However, you may want to enrich your users with some additional information or metadata. For example, you would like to fetch the user ID, which is only possible with the administrative login data. Or another example, your Flow uses the Google Maps Connector, and you want to provide your API key for all users. In this case you should specify Connector Auth for the corresponding Connector in Locoia and the end users won't be asked for login data.
Form Helper is a special Helper you can use if you want to customize what data will be requested from an end user.
When using a Scheduler Helper in an embed flow, the start datetime will be set to the date when the end user enabled the corresponding flow.
In order to automatically create webhooks for your end users, you have to use the webhook trigger for Connectors feature. This will automatically create a webhook for every end user enabled flow, triggering only their specific flow.
For each of your end users a separate Flow instance will be created. The Flow instance keeps the most Flow settings from the Flow you built:
Error email recipients
Flow data retention
Enable webhook token
Log all flow run steps
Automatic retries
Error Handling Flow
In Embed Flows you can reference to the non-sensitive variables passed in the JWT token:
embed_user_id
embed_user_name
embed_account_id
embed_account_name
embed_state