Smartsheet Module Reference

Applies to

Bridge by Smartsheet

Smartsheet Triggers

After you have set up the Smartsheet integration, you can choose events on a sheet to trigger a Bridge workflow.

Sheet ID

The ID or name of the sheet where events should trigger the workflow. If you type in the sheet name it will be replaced with the ID when you save the configuration. You can find the sheet ID by selecting File > Properties.

NOTE: To use the sheet name instead of the sheet ID, the sheet name must be unique.

Event Type

The type of event that will trigger the workflow.

Supported events are:

  • When Rows Are Created
  • When Rows Are Changed
  • When Column Are Added
  • When Column Properties Are Changed (note that this refers to the column name)
  • When Column Values Are Changed
  • When Comments Are Added
  • When Attachments Are Added

Column Name or ID

The name or the ID of the column that should trigger the workflow. If you specify the column name, it will be replaced with the ID when you save the configuration.

Select Workflow

The name of the workflow that will be triggered.

Workflow Runtime Data

When a trigger is saved, it is a webhook registered with Smartsheet. Each workspace registers one webhook, and within a workspace any incoming events are filtered based on the various triggers defined.

Incoming Smartsheet webhook events will be passed to the workflow runtime. You can reference it in workflows by typing {{runtime}}. The event object will contain the sheet ID of the modified sheet (if the update was due to the Smartsheet integration) and the event details that triggered the workflow.

Example Runtime

Example Smartsheet Runtime

The event will differ for each webhook event type:

  • The ID field will refer to the object type (in the example above, that objectType is a cell). 
  • eventType will either be created or updated 
  • objectType can be row, column, comment, attachment, and cell. 

You can see more detailed information on the possible event data types in the Smartsheet API documentation.


Add Comment To Row

This module either adds a comment or replies to an existing comment on a row in a sheet. 

Add Comment To Row fields

  • Sheet: the ID or unique name of the sheet that is to be modified. 
  • Row ID: the unique ID of the row that the comment will be added to.
  • Reply To: the ID of another comment that the new comment will be a reply to.
    NOTE: this parameter is optional and will be ignored when left blank.
  • Message: the message text to be added as the new comment or reply.

Add Comment to Row

Add Comment To Row returned data

  • Created At
  • Created By
    • Email
    • Name
  • ID (of comment)
  • Modified At

Add Row

Use this module to add a new row to a sheet.

Add Row fields

  • Sheet: the ID or unique name of the sheet that is to be modified. 
  • Cells: use this section to map data added to the row to columns on the sheet.
    • Key: the column name or ID
    • Value: the data you want to add in the column, on the row.
  • Advanced Cells: use this section for more advanced cell updates.
    • Column: the column name or ID.
    • Type: the type of cell data; value, formula or hyperlink.
    • Value: the cell value.
      NOTE: This field will only be used if Type is Value.
    • Formula: the formula to be set for the cell.
      NOTE: This field will only be used if Type is Formula
    • Hyperlink: the Hyperlink to be set on the cell. You can link to a URL, a sheet, or a report.
      NOTE: This field will only be used if Type is Hyperlink.
    • Override Validation: state if the cell will override any validation that has been set on the column when setting the value. You can select Default to use the value set in Advanced Options (see below).
  • Advanced Options
    • Numeric Dates: select if date values should be treated as Unix timestamps. This is for setting date values as well as a date format in the response. When this is not set, dates will be returned in the UTC time zone in ISO-8601 format (ex. YYYY-MM-DDTHH:MM:SS)
    • Locked: state if the row should be locked.
    • Expanded: state if the row should be expanded or collapsed.
    • Override Validation: set if you want to ignore validation for all cells in the row by default. You can also set it for each cell individually.
    • Location: state where the row will be added to the sheet
      • Top: add the row to the top of the sheet.
      • Bottom: add the row to the bottom of the sheet.
      • Parent ID: add the row as a child row to the specified row. By default it will be added as the first child of the parent. If Bottom is checked, it will be added as the last child.
      • Sibling ID: add the row next to the specified row. By default it will be added after the sibling. If Top is checked, it will be added above the sibling.

Add Row Smartsheet Setup

Add Row returned data

  • Cells
    • All columns include.:
      • Column ID
      • Display Value
      • Value
  • Created At
  • Expanded
  • ID (of new row)
  • Locked
  • Locked for User
  • Modified At
  • Row Number
  • Sheet ID 

Delete Row

Use this module to delete a row in a sheet.

Delete Row fields

  • Sheet: the ID unique name of the sheet that is to be modified. 
  • Row ID: the unique ID of the row that will be deleted.

Delete Row Smartsheet

The Delete Row module doesn't return any data.


Get Attachment

This module can get a specific attachment from a sheet.

Get Attachment fields

  • Sheet: the ID unique name of the sheet that is to be modified. 
  • Attachment ID: the unique ID of the attachment on the sheet.

Get Attachment

Get Attachment returned data

  • Attachment Type
  • Created At
  • Created By
    • Email
    • Name
  • ID (of attachment)
  • Mime type
  • Name
  • Parent ID
  • Parent Type
  • Size in Kb
  • URL
  • URL Expires in Milliseconds

Get Comment

Get a specific comment or discussion using its ID.

Get Comment fields

  • Sheet: the ID or unique name of the sheet that is to be modified. 
  • Comment ID: the unique ID of the comment on the sheet. You can also specify a discussion ID, in which case the first comment of the discussion will be returned.
  • Include Discussion: state if you want the discussion to also be included in the response. This will happen automatically if you give a discussion ID.

Get Comment Smartsheet

Get Comment returned data

  • Comment
    • Created At
    • Created By
      • Email
      • Name
    • ID
    • Modified At
    • Text
  • Discussion
    • Access level
    • Comment Count
    • Comments
      • Created At
      • Created By
        • Email
        • Name
    • ID
    • Modified At
    • Text
    • Created By
    • Email
    • Name
    • ID
    • Last Commented At
    • Last Commented User
      • Email
      • Name
    • Parent ID
    • Parent Type
    • Title

Get Report

This module can get details from a report in Smartsheet.

Get Report fields

  • Report: the ID or unique name of the report that is to be modified. 
  • Filters: options to filter the columns and rows that will be returned.
    • Page Number: used to get results in page batches. Specify a page number from 1 to the number of pages available (a number greater than possible will return the last page) to get a subsection of the results. This will default to 1 if it is not set.
    • Results Per Page: the number of results that will be returned at one time. This will default to 100 if not set.
  • Advanced Options:
    • Numeric Date: state if you want date values to be returned in numeric format, milliseconds since the UNIX epoch (midnight on January 1, 1970, in UTC time).
    • Include Attachments: include any attachments on the sheet and row.
    • Include Comments: include any comments and discussions on the sheet and row.
    • Include Link In from Cell details: includes status, rowId, and columnId from the Cell Link In details.
    • Include Links Out to Cells details: includes status, rowId, and columnId from the Cell Link Out details.
    • Source: include information on the report source.
    • Source Sheets: include information on the source sheets.

Get Report Smartsheet

Get Report returned data

  • Access Level
  • Cell Image Upload Enabled
  • Columns (all columns included)
    • Index
    • Sheet Name Column
    • Title
    • Type
    • Validation
    • Version
    • Virtual ID
    • Width
  • Created At
  • Effective Attachment Options (Evernote, Google Drive, File, Box.com, Dropbox, OneDrive, Egnyte, Link)
  • Gantt Enabled
  • ID
  • Modified At
  • Name
  • Permalink
  • Read Only
  • Rows
    • Access Level
    • Cells (all cells included)
      • Name
        • Column ID
        • Display Value
        • Value
        • Virtual Column ID
    • Created At
    • Expanded
    • ID
    • Modified At
    • Row Number
    • Sheet ID
    • Sibling ID
    • Access Level
    • Cells
      • Column ID
      • Display Value
      • Value
      • Virtual Column ID
    • Created At
      • Expanded
      • ID
      • Modified At
      • Row Number
      • Sheet ID
      • Sibling ID
    • Total Row Count

Get Row

This module can get details from a row in a sheet.

Get Row fields

  • Sheet: the ID or unique name of the sheet.
  • Row ID: the unique ID of the row.
  • Advanced Options
    • Numeric Date: state if you want date values to be returned in numeric format, milliseconds since the UNIX epoch (midnight on January 1, 1970, in UTC time).
    • Include Attachments: include any attachments on the row
    • Include Comments: include any comments and discussions on the row
    • Include Columns: includes information on all columns for the sheet.
    • Include Link In from Cell details: includes status, rowId, and columnId from the Cell Link In details.
    • Include Links Out to Cells details: includes status, rowId, and columnId from the Cell Link Out details.
    • Include Row Permanent Link: includes a direct link to the row in the Smartsheet application
    • Include Row Writer Information: includes additional details about the rows creator and who last modified it.
    • Exclude Empty Cells: excludes cells that have never contained any data.

Get Row Smartsheet

Get Row returned data

  • Row
    • Cells
      • Name
        • Column ID
        • Display Value
        • Value
  • Created At
  • Expanded
  • ID
  • Locked
  • Locked for user
  • Modified At
  • Row Number
  • Sheet ID
  • Version

Get Sheet

This module can get information from an entire sheet in Smartsheet.

Get Sheet fields

  • Sheet: the ID or unique name of the sheet that is to be modified.
  • Filters
    • Columns: the name or ID of the columns you want to include in the response. If this is not set, all columns are returned. The cell data returned will only include the selected columns.
    • Row IDs: a list of IDs for the rows that are to be included in the request.
    • Row Numbers: a list of row numbers for the rows that are to be included in the request. Non-existent row numbers will be ignored.
    • Page Number: used to get results in page batches. Specify a page number from 1 to the number of pages available (a number greater than possible will return the last page) to get a subsection of the results. This will default to 1 if it’s not set.
    • Results Per Page: the number of results that will be returned at one time. This wiill default to 100 if not set.
  • Advanced Options
    • Numeric Date: choose if you want date values to be returned in numeric format, milliseconds since the UNIX epoch (midnight on January 1, 1970, in UTC time).
    • Include Attachments: include any attachments on the sheet and row.
    • Include Comments: include any comments and discussions on the sheet and row.
    • Include Link In from Cell details: includes status, rowId, and columnId from the Cell Link In details.
    • Include Links Out to Cells details: includes status, rowId, and columnId from the Cell Link Out details.
    • Include Row Permanent Link: includes a direct link to the row in the Smartsheet application
    • Include Row Writer Information: includes additional details about the rows creator and who last modified it.
    • Exclude Empty Cells: excludes cells that have never contained any data.
    • Owner Info: include information on the owner of the sheet.
    • Source: include information on the sheet source.

Get Sheet Smartsheet

Get Sheet returned data

  • Access Level
  • Cell Image Upload Enabled
  • Columns
    • ID
    • Index
    • Primary
    • Title
    • Type
    • Validation
    • Version
    • Width
  • Created At
  • Dependencies Enabled
  • Effective Attachment Options (File, Box.com, Evernote, Dropdox, Egnyte, OneDrive, Google Drive)
  • Gantt Enabled
  • Has Summary Fields
  • ID
  • Modified At
  • Name
  • Permalink
  • Resource Management Enabled
  • Rows
    • Cells
      • Column Name
        • Column ID
        • Display Value
        • Value
      • Created At
      • Expanded
      • ID
      • Modified At
      • Row Number
      • Total Row Count
      • User Permissions
        • Summary Permissions
      • User Settings
        • Critical Path Enabled
        • Display Summary Tasks
  • Version

Get User

Get user details based on an email or user ID and route the workflow depending on if a user is found or not.

Get User fields

  • Name: the name of the junction.
  • User: the email or ID of the user.

Get User Smartsheet

Get User returned data

If Successful

  • Account
    • ID
    • Name
  • Alternate Emails
  • Company
  • Department
  • Email
  • First Name
  • ID
  • Last Name
  • Locale
  • Mobile Phone
  • Profile Image
    • Height
    • Image ID
    • Width
  • Role
  • Timezone
  • Title
  • Work Phone

If Unsuccessful

  • Message returned: "failed to find user "

List Sheets

List all the sheets that are available to you in Smartsheet.

List Sheets fields

  • Filters: options to filter the columns and rows that will be returned.
    • Modified Since: state if you want only the sheets that have been modified since a given time. The date is in the UTC time zone in ISO-8601 format, YYYY-MM-DDTHH:MM:SS. If Numeric Dates is set, then the date is in milliseconds since the UNIX epoch (midnight on January 1, 1970, in UTC time).
    • Page Number: used to get results in page batches, specify a page number from 1 to the number of pages available (a number greater than possible will return the last page) to get a subsection of the results. This will default to 1 if not set.
    • Results Per Page: the number of results that will be returned at one time. Will default to 100 if not set.
  • Advanced Options
    • Numeric Date: state if you want date values to be returned in numeric format, milliseconds since the UNIX epoch (midnight on January 1, 1970, in UTC time). When not set dates will be returned is in the UTC time zone in ISO-8601 format, YYYY-MM-DDTHH:MM:SS.
    • Sheet Version: include information on the sheet version.
    • Source: include information on the sheet source.

List Sheets Smartsheet

List Sheets returned data

  • Data
    • Access Level
    • Created At
    • ID
    • Modified At
    • Name
    • Permalink
    • Source
      • ID
      • Type
    • Version
  • Page Number
  • Page Size
  • Total Count
  • Total Pages

Manage Alternate Email

Manage alternative emails for a user.

This module will only function if you are authenticated as the system administrator of your Smartsheet account.

Manage Alternate Email fields

  • User: the email or ID of the user you want to modify.
  • Alternate Emails: a list of alternative emails you want to add to the user. You can leave this empty and select to delete other emails to remove all alternative emails from a user.
  • Delete other emails: state if you want to remove any alternative emails from the user that are already set (not specified as alternative emails above).

Manage Alternate Email Smartsheet

Manage Alternate Email returned data

  • Removed
  • Added
    • ID
    • Email

Remove Smartsheet User

Remove a Smartsheet user from your organization.

This module will only function if you are authenticated as the system administrator of your Smartsheet account.

Remove Smartsheet User fields

  • User: the email or unique ID of the user.
  • Remove From Sharing: remove the user from sharing for all sheets/workspaces.
  • Transfer Sheets: transfer the deleted user's sheets.
  • Transfer To: ID or email of user to transfer ownership of sheets/workspaces to.

Remove Smartsheet User


Search Sheet

Search a sheet and return the columns and rows that match filter conditions based on cell contents.

Search Sheet fields

  • Sheet: the ID or unique name of the sheet that is to be modified. 
  • Filters: options to filter the columns and rows that will be returned.
    • Columns: the name or ID of the columns you want to include in the response. If this is not set, all columns are returned. The cell data returned will only include the selected columns.
    • Row Filters: an array of filter conditions that will determine what rows will be returned. A row must satisfy every filter condition to be returned. If you specify multiple values for a filter condition, the condition only has to be valid for a single value. The two exceptions are Is Not Equal To, where the cell value must not equal any of the supplied values, and Between, where you must specify two values and the cell value to be a valid number between the specified start and end values, excluding the start and end values.
      • Column: the name or ID of the column.
      • Condition: the condition type to be applied to the filter.
      • Values: the values to be compared to the cell value based on the filter condition.
  • Advanced Options:
    • Numeric Date: state if you want date values to be returned in numeric format, milliseconds since the UNIX epoch (midnight on January 1, 1970, in UTC time).
    • Include Attachments: include any attachments on the sheet and rows.
    • Include Comments: include any comments and discussions on the sheet and rows.
    • Include Link In from Cell details: includes status, rowId, and columnId from the Cell Link In details.
    • Include Links Out to Cells details: includes status, rowId, and columnId from the Cell Link In details.
    • Include Row Permanent Link: includes a direct link to the row in the Smartsheet application.
    • Include Row Writer Information: includes additional details about the rows creator and who last modified it.
    • Exclude Empty Cells: excludes cells that have never contained any data.
    • Owner Info: Include information on the owner of the sheet.
    • Source: include information on the sheet source.

Search Sheet Smartsheet

Search Sheet returned data

The sheet data can be included by selecting the Advanced Option, Include Sheet Data. This will be the sheet object as defined by Get Sheet, with the rows and columns filtered as specified.

The data returned contains all columns (or only those set in the Filters) showing the Column Name and the value in the cell for all found rows.

Search Sheet Known Issues

Currently, filter conditions on date fields function differently depending on if Numeric Dates has been selected. 

  • If selected, the value will be treated as a number and the filter conditions must reflect that. 
  • Alternatively, if Numeric Dates is unchecked, then the cell value is a string; this means that Less Than, More Than, and Between filter conditions will not function.

Share Sheet

Share sheets with other users.

Share Sheet fields

  • Sheet: the ID or unique name of the sheet that is to be modified. 
  • Send Email: state if you want to send an email to the recipients as well as a notification in Smartsheet.
  • Recipients: a list of recipients for the share request
    • Email: the recipient's email address. 
    • Group ID: the recipient's group Id.

Either Email or Group ID must be specified, but not both. Group ID will be ignored in favor of Email if both are supplied.

  • Access Level: the access level for the recipient. This can be one of the following:
    • Admin
    • Editor
    • Editor with sharing
    • Owner
    • Viewer
  • Subject: the subject of the email to be sent to the recipient.
  • Message: the message of the email to be sent to the recipient.
  • CC Me: state if you should be included when emailing the recipient.

Share Sheet Smartsheet


Update Row

Update a row on a sheet.

Update Row fields

  • Sheet
  • Row ID
  • Calls
    • Key/Value
  • Advanced Cells: an array of column definitions.
    • Column: the column name or ID.
    • Input Type
      • Value: the cell value.
      • Formula: the formula expression to be set for the cell.
      • Hyperlink: the Hyperlink to be set on the cell. You can link to a URL, a sheet, or a report.
      • Link In From Cell: a link to another cell on another sheet to be set on the cell. You will need to specify the sheet, column, and row ID of the cell to link to this cell.
  • Advanced Options
    • Numeric Dates: state if date values should be treated as Unix timestamps. This is for setting date values as well as a date format in the response. When this is not set, dates will be returned in ISO 8601 format, i.e. 2000-12-25.
    • Locked
    • Expanded
    • Override Validation: set if you want to ignore validation for all cells in the row by default. You can also set it for each cell individually.
    • Location
      • Top: move the row to the top of the sheet.
      • Bottom: move the row to the bottom of the sheet. This will be ignored if Top is checked.
      • Parent ID: Move the row as a child row to this specified row. It will be moved as the first child of the parent unless Bottom is checked. If Bottom is checked, it will be moved as the last child.
      • Sibling ID: move the row next to the specified row. It will be moved after the sibling unless Top is checked. If Top is checked, it will be moved above the sibling.

Update Row Sheet

Update Row returned data

This module will return information on the updated row.

  • Column Name
    • Column ID
    • Display Value
    • Value
  • Created At
  • Expanded
  • ID
  • Modified At
  • Row Number

Update Smartsheet User

Update a user's permissions and name.

This module will only function if you are authenticated as the system administrator of your Smartsheet account.

Update Smartsheet User fields

  • User: the email of ID of the user you want to modify.
  • Is System Admin: indicates whether the user is a system admin (can manage user accounts and organization account).
  • Is Licensed Sheet Creator: indicates whether the user is a licensed user (can create and own sheets).
  • Is Group Admin: indicates whether the user is a group admin (can create and edit groups).
  • Is Resource Viewer: indicates whether the user is a resource viewer (can access resource views).
  • Profile
    • Title
    • First Name
    • Last Name
    • Company
    • Department
    • Role
    • Mobile Phone
    • Work Phone

Update Smartsheet User

Update Smartsheet User returned data

  • User
    • Email
    • First Name
    • Last Name
    • ID
    • Admin
    • Licensed Sheet Creator