Automation

The Automation widget allows you to embed the Automated Flows feature within an application.

Embeddable Script

<!-- Tag -->
<qrvey-workflow-design settings="config"></qrvey-workflow-design>

<!-- Config -->
<script>
var config = {
  apiKey: '<API_KEY>',
  domain: '<DOMAIN>',
  userId: '<USER_ID>',
  appId: '<APP_ID>'
};
</script>

<!-- Launcher -->
<script type="text/javascript" src="https://<your_qrvey_domain>/widgets-launcher/app.js"></script>

Configuration Object

Parameter	Description	Required	qvToken Support
domain	String. Base URL of the Qrvey instance.	Required if apiKey is not provided.	No
qvToken	String. Encrypted token used for secure authentication.	Required if apiKey is not provided.	No
apiKey	String. Your organization’s unique API key required to access the Qrvey platform.	Required if qvToken is not provided.	No
userId	String. ID of the Qrvey User that owns the application being embedded.	Required	Yes
appId	String. ID of the Qrvey application that contains the asset you want to embed.	Required	Yes
workflowId	String. ID of a single flow. If configured, the widget will open that flow. If omitted, the widget will display the "browse all workflows" page.	Optional	Yes
timezone	Object. Overrides the time zone setting in the Qrvey Admin Center. See The Timezone Object for details.	Optional	Yes
orgId	String. User organization identifier, which can be any string value.	Optional	Only
clientId	String. A unique identifier of the tenant end user. Enables the use of the End User Personalization and Download Manager features.	Optional	Only

In the Automation widget, the clientId links flows to the end user who created them, allowing the export of personalized dashboards.

Note: Passing clientId in a widget activates a "Show Personalized Dashboards" checkbox in the attachment modal of the Send Email action inside a Flow. This checkbox must be checked for the feature to apply.

Timezone

For more information, see Configuring Time Zone Settings.

Parameter	Description	Required
offset	String. Time to offset by. Pattern: {"HH:MM"}. Example: { "offset": "-1:00" }.	Optional