> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://help.sigmacomputing.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://help.sigmacomputing.com/_mcp/server. # Example representation: Workbook with a conditional action trigger (Beta) > Example Sigma code representation of a workbook with a conditional action trigger. 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](/docs/sigma-product-releases#beta-features). This is an example representation of a workbook, retrieved using the [Get a workbook](/reference/get-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](/reference/create-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](/docs/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](/docs/manage-workbooks-as-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](/docs/account-type-and-license-overview) 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](/docs/account-type-and-license-overview) 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](/reference/get-started-sigma-api). This example uses a table from the [Sigma Sample Connection](/docs/sigmas-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 where a search box only filters the table once the reader has typed at least three characters. The condition lives on the trigger, so below that length the sequence does not run at all. To create this workbook in the Sigma UI: 1. Go to the **Home** page. 2. Select ![](https://sigma-docs-screenshots.s3.us-west-2.amazonaws.com/Icons/button-add.svg) **Create new** > **Workbook**. A new workbook opens. 3. From the **Add element** bar, select **Data** > **Table**. 4. In the **Select source** modal, search for the table `TRIP` in the `EXAMPLES.BIKES` schema. 5. Select the table to add it to the workbook. The table appears in the workbook. 6. From the **Add element** bar, select **Controls** > **Text**. 7. Select the control, then in the **Properties** tab of the editor panel, configure the following settings: | Option | Setting | | :------------- | :--------------- | | **Control ID** | `station-filter` | | **Label** | Station filter | | **Operator** | **Contains** | 8. Select **Targets**, then add the *Trip* table as a target on the *Start Station Name* column. 9. From the **Add element** bar, select **Controls** > **Text**, then configure the second control with the following settings: | Option | Setting | | :------------- | :--------------- | | **Control ID** | `station-search` | | **Label** | Search stations | | **Operator** | **Contains** | 10. With the search control selected, in the editor panel, open the **Actions** tab. 11. Select ![](https://sigma-docs-screenshots.s3.us-west-2.amazonaws.com/Icons/button-add.svg) **Add action sequence**, then set the trigger to **On change**. 12. Add a condition to the trigger with the formula `Len([station-search]) >= 3`. 13. Configure the action with the following settings: | Option | Setting | | :---------- | :--------------------------- | | **Action** | **Set control value** | | **Control** | `station-filter` | | **Value** | The `station-search` control | Typing one or two characters changes the search box but leaves the table alone, because the trigger condition is false and the sequence never runs. At three characters the search value is copied into `station-filter` and the table filters. 14. In the document header, select **Save as**. 15. Enter a name for the workbook, such as `conditional-action-trigger`. 16. Select **Save**. ## 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](/docs/get-the-code-representation-of-a-workbook). The code representation of this workbook appears like the following: #### YAML representation ```yaml workbookId: d810c331-5cbf-46ff-b52a-70d077688a2c workbookUrlId: BHhBjtZEm7HXvoZANKHvso createdBy: zgzXpTRVbfX4ZE9TEm9q9fUsfXZ5o updatedBy: zgzXpTRVbfX4ZE9TEm9q9fUsfXZ5o createdAt: '2026-09-01T14:57:53.708Z' updatedAt: '2026-09-02T21:09:24.909Z' name: conditional-action-trigger url: https://aws-api.sigmacomputing.com/org-name/workbook/BHhBjtZEm7HXvoZANKHvso path: My Documents/ latestVersion: 6 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 - kind: control controlId: station-search id: GCP04jzS name: Search stations actions: - id: GZMaWxkSIqO1dOP trigger: 'on': on-change condition: type: formula formula: Len([station-search]) >= 3 effects: - effect: set-control-value control: station-filter value: type: control control: station-search case: insensitive controlType: text mode: contains includeNulls: when-no-value-is-selected showOperators: false - kind: control controlId: station-filter id: rlj0WQtH name: Station filter filters: - source: kind: table elementId: eTizXgX columnId: cOIGflvCqIlC case: insensitive controlType: text mode: contains includeNulls: when-no-value-is-selected showOperators: false pages: - id: eKhTktnw name: Page 1 kind: workbook layout: | documentVersion: 6 ``` ## Representing conditional action triggers #### Conditional action trigger representation ```yaml ... actions: - id: GZMaWxkSIqO1dOP trigger: 'on': on-change condition: type: formula formula: Len([station-search]) >= 3 effects: - effect: set-control-value control: station-filter value: type: control control: station-search ... ```