Example representation: Workbook with an automated 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 an automated action sequence that runs a Sigma agent on a recurring schedule.

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 Data > Table.
In the Select source modal, search for the table TRIP in the EXAMPLES.BIKES schema.
Select the table to add it to the workbook.

The table appears in the workbook.
Create a Sigma agent in the workbook named Trip summary, using the Trip table as its data source.
Give the agent instructions that summarize the previous day’s trips, such as the busiest start station and the average trip duration.
Select the background of the workbook canvas to open the page-level editor panel, then select the Actions tab.
In the Actions panel, select Add action sequence.
In the action configuration popover, select Call agent, then select the Trip summary agent and enter the prompt to send it.
In the sequence card, select the Select a schedule field, then configure the sequence to run daily at 9:00 AM.
In the workbook header, select Publish.

Sigma only runs automated action sequences that are saved to the published version of a workbook.
In the document header, select Save as.
Enter a name for the workbook, such as automated-action.
Select Save.

An automated action sequence can only call an agent. The other action effects, such as Refresh element, are available on element-triggered sequences but not on a schedule.

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: 8f72fde8-d3b2-4b73-9600-45b8186bdcaa
workbookUrlId: tUV9vkxBKFwttCUpoC0hWt
createdBy: zgzXpTRVbfX4ZE9TEm9q9fUsfXZ5o
updatedBy: zgzXpTRVbfX4ZE9TEm9q9fUsfXZ5o
createdAt: '2026-09-01T14:55:19.675Z'
updatedAt: '2026-09-02T17:21:45.430Z'
name: automated-action
url: https://aws-api.sigmacomputing.com/org-name/workbook/tUV9vkxBKFwttCUpoC0hWt
path: My Documents/<folder-name>
latestVersion: 2
ownerId: zgzXpTRVbfX4ZE9TEm9q9fUsfXZ5o
isArchived: false
contents:
  schemaVersion: 1
  elements:
    - id: eTizXgX
      kind: table
      source:
        connectionId: b2af3691-12a0-48fa-a91d-fbe2e1b31627
        kind: warehouse-table
        path:
          - EXAMPLES
          - BIKES
          - TRIP
      columns:
        - id: 6DqBgE6Rq
          formula: '[TRIP/Id]'
        - id: wOW6NNWOZqI
          formula: '[TRIP/Duration]'
        - id: jC0c8h8Ewz3g
          formula: '[TRIP/Start Date]'
        - id: cOIGflvCqIlC
          formula: '[TRIP/Start Station Name]'
        - id: JpVJowwqZg
          formula: '[TRIP/Start Station Id]'
        - id: GyZynaXgfv
          formula: '[TRIP/End Date]'
        - id: qQzuJifMd2
          formula: '[TRIP/End Station Name]'
        - id: 3Esuzz9y
          formula: '[TRIP/End Station Id]'
        - id: a1ySXDMEm
          formula: '[TRIP/Bike Id]'
        - id: Kng0H6Uvst
          formula: '[TRIP/Subscription Type]'
        - id: B0QtJd
          formula: '[TRIP/Zip Code]'
      order:
        - 6DqBgE6Rq
        - wOW6NNWOZqI
        - jC0c8h8Ewz3g
        - cOIGflvCqIlC
        - JpVJowwqZg
        - GyZynaXgfv
        - qQzuJifMd2
        - 3Esuzz9y
        - a1ySXDMEm
        - Kng0H6Uvst
        - B0QtJd
  pages:
    - id: eKhTktnw
      name: Page 1
  agents:
    - id: Zw8TEZNyTb5IB1m2
      instructions: >-
        Summarize yesterday's bike trips from @dataSource("eTizXgX"), calling out the busiest start station and the
        average trip duration.
      name: Trip summary
      dataSources:
        - kind: table
          elementId: eTizXgX
  automatedActions:
    - effects:
        - agentId: Zw8TEZNyTb5IB1m2
          effect: call-agent
          prompt: Summarize yesterday's trips.
      id: nRLGeypzfXktgoy
      schedule:
        cronSpec: 0 9 * * *
        timezone: America/New_York
      trigger: schedule
      name: Daily trip summary
  kind: workbook
  layout: |
    <?xml version="1.0" encoding="utf-8"?>
    <Page type="grid" gridTemplateColumns="repeat(24, 1fr)" gridTemplateRows="auto" id="eKhTktnw">
      <Element elementId="eTizXgX" gridColumn="1 / 25" gridRow="1 / 21"/>
    </Page>
documentVersion: 2

Representing automated actions

Automated action representation

...
automatedActions:
- effects:
  - agentId: Zw8TEZNyTb5IB1m2
    effect: call-agent
    prompt: Summarize yesterday's trips.
  id: nRLGeypzfXktgoy
  schedule:
    cronSpec: 0 9 * * *
    timezone: America/New_York
  trigger: schedule
  name: Daily trip summary
...