Example representation: Workbook with a send embed event action (Beta)

This documentation describes one or more public beta features that are in development. Beta features are subject to quick, iterative changes; therefore the current user experience in the Sigma service can differ from the information provided in this page.

This page should not be considered official published documentation until Sigma removes this notice and the beta flag on the corresponding feature(s) in the Sigma service. For the full beta feature disclaimer, see Beta features.

This is an example representation of a workbook, retrieved using the Get a workbook endpoint with the query parameter includeContents=true. Representations like this one can be used to create a workbook from code using the Create a workbook endpoint. Each page in this example library includes the code representation of the workbook and step-by-step instructions to create it in the Sigma UI.

Consult this example and others in the Workbook representation example library to:

Troubleshoot the formatting of a particular feature in code representation
Relate a feature from the Sigma UI to its representation in code
Provide context to AI tools used to create workbooks from code

This example representation cannot be used as-is. All identifying details, such as IDs, names, and URLs, have been replaced with randomized ID values or generic substitutions. The format of these contents, like the length of ID values, is preserved for demonstrative purposes. However, this representation cannot be directly used without modification to the base URL, connection details, and more. For more information, see Create and manage workbooks from code.

System and user requirements

To complete the steps in this example, you must meet the user requirements listed below for creating the workbook in the UI and creating it from code.

The ability to create this workbook in the Sigma UI requires the following:

You must be assigned an account type with the Create, edit, and publish workbooks permission enabled.
You must have access to a connection to a data platform.

The ability to create a workbook from code requires the following:

You must be assigned an account type with the Create, edit, and publish workbooks permission enabled.
You must have developer credentials for the Sigma API. For more information, see Get started with the Sigma REST API.

This example uses a table from the Sigma Sample Connection. Your organization might have disabled access to the Sigma sample connection. If so, you can contact an admin to enable it, or use a table from another connection to follow along with this example.

Create the example workbook in the Sigma UI

This example shows a workbook with a button that sends an event to the host page using a Generate iframe event action.

To create this workbook in the Sigma UI:

Go to the Home page.
Select Create new > Workbook.

A new workbook opens.
From the Add element bar, select UI > Button.
In the editor panel, open the Actions tab.
Select Add action.
Configure the action with the following settings:

Option Setting
Action Generate iframe event
Event A name for the outbound event

When you embed the workbook in an iframe, the host page listens for the event. The UI calls this action Generate iframe event, and the representation records it as a send embed event effect.
In the document header, select Save as.
Enter a name for the workbook, such as send-embed-event-action.
Select Save.

Option	Setting
Action	Generate iframe event
Event	A name for the outbound event

Get a code representation of this workbook

To get a representation of this workbook, follow the steps in Get the code representation of a workbook.

The code representation of this workbook appears like the following:

YAML representation

workbookId: 5fc4c34e-ba18-470b-b11b-c60a68ee961f
workbookUrlId: iYTfPqEFUoC9DP93nXzsQ3
createdBy: zgzXpTRVbfX4ZE9TEm9q9fUsfXZ5o
updatedBy: zgzXpTRVbfX4ZE9TEm9q9fUsfXZ5o
createdAt: '2026-09-01T14:57:50.539Z'
updatedAt: '2026-09-02T20:13:16.059Z'
name: send-embed-event-action
url: https://aws-api.sigmacomputing.com/org-name/workbook/iYTfPqEFUoC9DP93nXzsQ3
path: My Documents/<folder-name>
latestVersion: 4
ownerId: zgzXpTRVbfX4ZE9TEm9q9fUsfXZ5o
isArchived: false
contents:
  schemaVersion: 1
  elements:
    - id: MHEDLe3B
      kind: button
      text: Notify host page
      appearance: filled
      actions:
        - id: sZLDXiE
          trigger: on-click
          effects:
            - effect: send-embed-event
              eventName: trip-selected
              payload:
                - key: source
                  value:
                    type: constant
                    value:
                      type: text
                      value: example-library
  pages:
    - id: eKhTktnw
      name: Page 1
  kind: workbook
  layout: |
    <?xml version="1.0" encoding="utf-8"?>
    <Page type="grid" gridTemplateColumns="repeat(24, 1fr)" gridTemplateRows="auto" id="eKhTktnw">
      <Element elementId="MHEDLe3B" gridColumn="1 / 25" gridRow="1 / 7"/>
    </Page>
documentVersion: 4

Representing the send embed event action

Send embed event action representation

...
actions:
- id: sZLDXiE
  trigger: on-click
  effects:
  - effect: send-embed-event
    eventName: trip-selected
    payload:
    - key: source
      value:
        type: constant
        value:
          type: text
          value: example-library
...