Automation Widget

Use the Automation widget 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

Local and scheduled exports created from this widget are associated with the clientId and orgId that control their display in the Download Manager.

Parameter	Type	Required	qvToken Support	Description
domain	string	Y (if apiKey is not provided)	N	Base URL of the Qrvey instance.
qvToken	string	Y (if apiKey is not provided)	N	Encrypted token used for secure authentication.
apiKey	string	Y (if qvToken is not provided)	N	Your organization’s unique API key required to access the Qrvey platform.
userId	string	Y	Y	ID of the Qrvey User that owns the application being embedded.
appId	string	Y	Y	ID of the Qrvey application that contains the asset you want to embed.
workflowId	string	N	Y	ID of a single flow. If configured, the widget opens that flow. If omitted, the widget displays the "browse all workflows" page.
timezone	object	N	Y	Overrides the time zone setting in the Qrvey Admin Center. For more information, see The Timezone Object.
orgId	string	N	Y	User organization identifier, which can be any string value. Exports created from the widget are owned by the clientId under the orgId. For more information, see Exports.
clientId	string	N	Y	Unique identifier of the tenant end user. Enables the use of the End User Personalization and Download Manager features.

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.

Exports

Local and scheduled exports created from this widget are associated with the clientId and orgId that control their display in the Download Manager widget.

If clientId and orgId are passed through a JWT to the widget, the same JWT is sent to the export requests and considered when creating the Download Manager records, even if the widget itself does not use these properties.

Timezone

For more information, see Configuring Time Zone Settings.

Parameter	Type	Description	Required
offset	string	N	Time to offset by. Pattern: {"HH:MM"}. Example: { "offset": "-1:00" }.