Create actions that generate embed iframe events

Workbook actions configured in an embedded workbook support interaction with host applications. You can configure an action to send an iframe event from your embedded content to your host application, which can then react to this event with some outcome. For example, you can use these events to add custom tracking, change the UI of your application, or trigger your own application APIs.

This document explains how to configure the Generate iframe event action in an embedded workbook. For more information about actions in Sigma, see Intro to actions. For more information about embedding, see Intro to embedded analytics.

System and user requirements

📘
The following requirements apply to users who configure actions. Users who access and interact with a workbook can typically trigger all existing actions within it. Any restrictions are noted in this document.

The ability to configure actions requires the following:

You must be assigned an account type with the Full explore or Create, edit, and publish workbooks permission enabled.
You must be the workbook owner or be granted Can explore¹ or Can edit access to the workbook.

1If you’re granted Can explore access to the workbook, you can configure actions in custom, saved, and shared views. Actions saved to views do not apply to the workbook’s published version.

This workbook action is only relevant for embedded workbooks. See Intro to embedded analytics for specific requirements for public and secure embedding.

Prerequisites

Configure an event listener and an action:outbound event in your application to receive messages about the user interactions in the embedded workbook. You can then develop custom logic in your host application to respond to these events.

See Implement inbound and outbound events in embeds for information about about how to send and receive events between a parent application and Sigma.
See the configuration instructions for the action:outbound event to configure the outbound event required for this workbook action to take effect.

Generate an outbound iframe event

Create an action that generates an outbound iframe event.

Open the draft, custom view, or saved view of a workbook.
Select the trigger element (the element users must interact with to initiate the action).
In the editor panel, open the Actions tab.
Create a new sequence, or locate an existing sequence that you want to modify.
Select the default action (if creating a new sequence), or click Add action to add a new action to the sequence.
In the modal, configure the required fields to define the response:


Action	Select Generate iframe event.
Event name	Enter the name of the event configured in the `name` property in the `action:outbound` event in your host application.
Event key and Key value	Enter the key names and values configured in the `values` property in the `action:outbound` event in your host application.

Updated 12 days ago