To get started working with the Smartsheet application, the first step is to integrate an existing Smartsheet account with the Designer. If you do not have an existing Smartsheet account and you wish to use Smartsheet with the Designer, sign up for Smartsheet first, and then return to the authorization process.
Was this article helpful?
General
For information on specific errors being returned from the Smartsheet API, see the Smartsheet API docs.
Authentication
Having difficulties connecting to your Smartsheet account? Try reauthorizing your account in Settings –> Accounts, or deleting the account and adding it again.
You can find a list of all your available accounts under Settings –> Accounts.
We are constantly aggregating more data about errors, so if this article doesn’t help solve your problem, check back soon.
The Monitor Column Event Card monitors for updates or additions to a column inside a Smartsheet sheet.
Important: In addition to the output fields listed below, the Monitor Column Card will also generate a number of dynamic output fields. These fields are generated based on the names you have given the rows within your Smartsheet sheet.
Waits to receive an incoming request from Smartsheet containing information about an updated column. This request occurs whenever a column is updated within a Smartsheet sheet.
Monitor for new attachments in a sheet.
Monitor for new comments on a sheet.
Waits to receive an incoming request from Smartsheet containing information on new comments in a sheet. This request occurs whenever a comment is added within a Smartsheet sheet. Does not work with comment replies.
Monitor for new rows in a sheet.
Row
Metadata
Waits to receive an incoming request from Smartsheet containing information on newly created rows. This request occurs whenever a new row is created within a Smartsheet sheet.
Monitor for updated rows in a sheet.
Waits to receive an incoming request from Smartsheet containing information on updated rows. This request occurs whenever a row is updated within a Smartsheet sheet.
Yes or No.Start FLO when a new row is added to a report, or an existing row is updated
Create a new row in a Smartsheet sheet.
Note: Smartsheet only allows 5000 rows per sheet.
Required fields are indicated in red.
Insert ID to select a Smartsheet sheet by its ID, which is entered in the Input section.The input fields for this card are dynamically generated based on your instance.
Sheet * ID (text): Unique identifier of the sheet you want to use.
Note: If the Restrict to… checkbox at the bottom of the Insert Column or Edit Column Properties form is checked in Smartsheet, you need to fill in the correct data to pass data validation.
Columns
Row * id (text): The Smartsheet ID for the created row. * rowNumber (text): The number assigned to the newly created row.
Create multiple new rows in a Smartsheet sheet.
Note: Smartsheet only allows 5000 rows per sheet.
Required fields are indicated in red.
Insert ID to select a Smartsheet sheet by its ID, which is entered in the Input section.The input fields for this card are dynamically generated based on your instance.
Sheet * ID (text): Unique identifier of the sheet
Add
build row object card is needed. Each build row object card takes a text input for each column in the associated sheet.row output on each build row object card into a list construct card.list output from the list construct card into the rows input on the add rows card.
Location * Row ID (text): Unique identifier of the row
Attach a file to a Smartsheet comment using the comment ID.
Required fields are indicated in red.
Insert ID to select a Smartsheet sheet by its ID, which is entered in the Input section.The input fields for this card are dynamically generated based on your instance.
Sheet
Comment
File
Attachment
Attaches a file to a Smartsheet row
Sheet (this field only appears if ‘– Select ID –’ is selected in the ‘Your Smartsheet Sheets’ dropdown menu)
Row
File
Attachment
Attaches a file to a Smartsheet sheet
Sheet (this field only appears if ‘– Select ID –’ is selected in the ‘Your Smartsheet Sheets’ dropdown menu)
File
Attachment
Attaches a URL link to a Smartsheet comment
Attaches a URL link to a Smartsheet row
Attaches a URL link to a Smartsheet sheet
Use with ‘Add Rows’ or ‘Update Rows’ to create or update more than one row in a sheet.
Input fields for Build Row Object are dynamically generated per Smartsheet sheet. For each column in a sheet, an input field will be generated. Input fields will be named with respect to the column they refer to.
For example, if a column is named “Date” in a Smartsheet sheet, it will have a corresponding input field named “Date”.
If no custom names are specified, the default Smartsheet naming scheme (Column1, Column2, …) will be used.
If ‘Update Rows’ is selected from the ‘Action’ dropdown menu, then a Row ID field will appear so that you can specify a row.
If the ‘Restrict to…’ checkbox at the bottom of the Insert Column or Edit Column Properties form is checked in Smart sheet UI, you need to fill in the correct data to pass data validation.
For example, for Date column type, if ‘Restrict to dates only’ is checked, a date like “02/12/2018” should be filled;
for Dropdown List column type, if ‘Restrict to dropdown values only’ is checked, only one option value from the list should be filled;
for Contact List column type, if ‘Restrict to list values only’ is checked, the email address should be filled if email address is available, otherwise, name should be filled.
Add a comment to a row in a Smartsheet sheet.
Required fields are indicated in red.
Insert ID to select a Smartsheet sheet by its ID, which is entered in the Input section.The input fields for this card are dynamically generated based on your instance.
Sheet * ID (text): Unique identifier of the sheet you want to use.
Comment * Row ID (text): The Smartsheet ID for the row. * Comment (text): Comment to be added to the row.
Comment * ID (text): The ID of the resulting comment. You’ll need this ID to do something else with the comment, such as Attach URL to Comment.
Adds a comment to a Smartsheet sheet
Creates a copy of the specified folder.
Home.* **Folder ID** _(Number)_: The ID of the newly created folder copy.Copy a row between sheets.
Note: Smartsheet only allows 5000 rows per sheet.
Required fields are indicated in red.
Copy * Sheet ID From (text): Smartsheet id of the sheet being copied from * Sheet ID To (text): Smartsheet id of the sheet being copied to * Row ID (text): Row id of the row to be copied
Include
* Attachments (true/false): If true, attachment file will be included with the copied row
* Discussions (true/false): If true, associated discussions will be included with the copied row
* Children (true/false): If true, associated children will be included with the copied row
Result * Copied Row ID (text): ID of the new row that was created as a result of the action
Sights, now called Dashboards in the new SmartSheet, are a collection of widgets that can contain data from a variety of different data sources (for example, sheets, reports, or custom data).
Copy sight allows you to copy one of those sights (dashboards) to a new location.
Home is the copy destinationCreate a dropdown list.
Any additional information that should be known about the input fields, i.e., there is something very different about these input fields relative to other input fields.
Options
Result
Creates a new folder in the home folder, as a subfolder of another folder, or in a workspace.
Create a new sheet.
Input fields vary depending on the option selected.
Create a new workspace.
Workspace
Result
Defines a cell value to be either a contact, hyperlink or celllink.
The input field options will change depending on which cell type you choose:
Delete multiple rows in a Smartsheet sheet.
Required fields are indicated in red.
Insert ID to select a Smartsheet sheet by its ID, which is entered in the Input section.Sheet * ID (text): Unique identifier of the sheet
Delete
Downloads an attachment from Smartsheet
Sheet (this field only appears if ‘– Select ID –’ is selected in the ‘Your Smartsheet Sheets’ dropdown menu)
Attachment
Attachment
Sights, now called Dashboards in the new SmartSheet, are a collection of widgets that can contain data from a variety of different data sources (for example, sheets, reports, or custom data).
Create Group allows you to create a new Smartsheet Group. Groups allow you to quickly share sheets and workspaces between group memebers
Downloads all attachments from a Smartsheet discussion
Sheet (this field only appears if ‘– Select ID –’ is selected in the ‘Your Smartsheet Sheets’ dropdown menu)
Discussion
Outputs
Download a report in either .csv or .xlsx format.
Downloads all attachments from a Smartsheet row
Sheet (this field only appears if ‘– Select ID –’ is selected in the ‘Your Smartsheet Sheets’ dropdown menu)
Row
Outputs
Download a sheet in either .csv, .pdf, or .xlsx format.
Downloads all attachments from a Smartsheet sheet
Sheet (this field only appears if ‘– Select ID –’ is selected in the ‘Your Smartsheet Sheets’ dropdown menu)
Outputs
Allows you to make a customized HTTP request to the Smartsheet API. For the most in depth information on the nature of those requests. See the documentation for Smartsheet here.
Request Type (dropdown): The type of request you’d like to make. See Squarespace HTTP Requests. * GET * POST * PUT * PATCH * DELETE
Request
/api/v2/{insert_remaining_URL}. You can specify query parameters in the relative URL using “?”, or specify the query parameters as an object key pair in the Query input.Response * Status Code (number): success or failure of your HTTP request. Here is a list of all status codes. * Headers (object): a detailed context for the status code, unrelated to the output body. Response headers are dependent on your selected HTTP request option. Note that not all headers are response headers. This will usually be a replica of the example below.
Example: {"Content-type":"application/json"}GET request).Get a list of all of the sheets the selected account has access to, optionally filtered.
Moves a folder to a new location.
Move a row between sheets.
Note: Smartsheet only allows 5000 rows per sheet.
Required fields are indicated in red.
Copy * Sheet ID From (text): Smartsheet id of the sheet being copied from * Sheet ID To (text): Smartsheet id of the sheet being copied to * Row ID (text): Row id of the row to be copied
Result * Moved Row ID (text): ID of the new row that was created as a result of the action
This card will move a sheet to a the folder or workspace you specify.
Sheet ID (text): the ID of the sheet you want to move.
Folder/Workspace ID (text): the ID of the folder or workspace that you want to move the sheet to.
Reads all groups from a Smartsheet connection, and returns all groups as a list of objects.
Groups (list): A list of ‘Group’ objects. Each object includes:
Name (text): the name of the group.
Group ID (number): the ID of the group.
Description (text): a description of the group.
Owner Email (text): the email address of the group owner.
Owner User ID (number): Group owner’s user Id.
Created At (text): Time of group creation.
Updated At (text): Time of last modification to group.
There is an additional option to include more information in the group objects, accessible by using the “Enter key name here” field. If you don’t have a reason to include additional information, it is unlikely that you need to use the additional field.
Reads all rows from a sheet and returns all rows in the sheet as a list of objects.
Note: This action will read all columns regardless of column output(s) selected.
Sheet ID (only if you selected –Sheet ID– in options) (text): the ID of the sheet you want to read.
Outputs
Rows (list): A list of ‘Row’ objects. Each object includes:
Row ID (text): The ID of the row.
Row Number (text): The number of the row as it appears in Smartsheet.
Columns (object): A dynamically generated object containing the values from each column in the row.
There is an additional option to include more information in the row objects, accessible by using the “Enter key name here” field. If you don’t have a reason to include additional information, it is unlikely that you need to use the additional field.
Returns information about all sights in a Smartsheet connection as a list of objects.
Sights (list): a list of all sights, as objects. Each object includes:
Sight ID (number): the ID of the sight.
Name (text): the name of the sight.
Access Level (text): the user’s permissions on the Sight. For more information, visit this link: http://smartsheet-platform.github.io/api-docs/#access-levels
Sight URL (text): the URL that represents a direct link to the Sight in Smartsheet.
Created At (text): timestamp of the time of creation.
Modified At (text): timestamp of the last modification.
There is an additional option to include more information in the object list, accessible by using the “Enter key name here” field. If you don’t have a reason to include additional information, it is unlikely that you need to use the additional field.
Reads an entire column from a Smartsheet sheet.
Outputs
Returns a list of values between a starting row and ending row in a given column. Each value between the start row and the end row will be extracted from the specified column.
Note: the starting row value is contained within the returned output, but the ending row value is not.
Your Smartsheet sheets (dropdown list): a list of all available Smartsheet sheets associated with your Smartsheet account. You can also select –Insert ID– to define the sheet as an input.
Your sheet’s columns (dropdown list): a list of all columns associated with the chosen sheet. You can also select –Insert ID– to define the column as an input.
start(text): the starting row number. The data in this row will be contained in the output.
end (text): the ending row number. The data in this row will not be contained in the output.
Columns
Returns information about a group based on the given Smartsheet group ID.
Name (text): the name of the group.
Description (text): a description of the group.
Owner Email (text): the email address of the group owner.
Owner User ID (number): Group owner’s user Id.
Members (list): a list of all members of the group, as objects. Each object contains the following information:
User ID (number)
Email (text)
First Name (text)
Last Name (text)
Full Name (text)
There is an additional option to include more information in the object list, accessible by using the “Enter key name here” field. If you don’t have a reason to include additional information, it is unlikely that you need to use the additional field.
Created At (text): Time of group creation.
Updated At (text): Time of last modification to group.
Read the values of a row in Smartsheet using the row ID.
Required fields are indicated in red.
Insert ID to select a Smartsheet sheet by its ID, which is entered in the Input section.Sheet * ID (text): Unique identifier of the sheet you want to use.
Row * ID (text): The ID of the row you wish to read.
Columns The output fields are dynamically generated based on your instance.
Read the values of a row in Smartsheet using the row number.
Required fields are indicated in red.
Insert ID to select a Smartsheet sheet by its ID, which is entered in the Input section.Read by * Sheet ID (text): Unique identifier of the sheet you want to use. * Row Number (text): The number of the row that you want to read.
The output fields for this card are dynamically generated based on your instance.
Row * ID (text): The ID of the row you wish to read.
Returns information about a sight based on the given Smartsheet sight ID.
Name (text): the name of the sight.
Access Level (text): the user’s permissions on the Sight. For more information, visit this link: http://smartsheet-platform.github.io/api-docs/#access-levels
Column Count (number): the number of columns that the Sight contains.
Sight URL (text): the URL that represents a direct link to the Sight in Smartsheet.
Created At (text): timestamp of the time of creation.
Modified At (text): timestamp of the last modification.
Search all cells in a column for a specified value.
Your Smartsheet sheets (dropdown list): a list of all available Smartsheet sheets associated with your Smartsheet account. If you choose the option – Insert ID – you will be able to dynamically input a sheet ID from an action previously in the Flow.
Return (dropdown list): Choose ‘Single Row’ to return the first result, or choose ‘All Rows’ to return a list of all results.
Sheet ID (this field only appears if ‘– Select ID –’ is selected in the ‘Your Smartsheet Sheets’ dropdown menu) (text): the ID of the sheet you want to share
Columns: A dynamically generated list of all columns in your chosen sheet. Enter values in the columns that you wish to search by. * Note - if field is a boolean, search 1 for ‘true’ and 0 for ‘false’
Searches the specified sheet for a specific value based on a text string input, returns the first match it finds. The search can be a partial or exact match, but will return the first matching record.
id (text): returns the ID of the object that was searched for.
type (text): the type of the object where it found a match. The following types are possible results:
Searches the specified object type for a specific value based on a text string input.
The text string you use needs to directly match the object you are looking for. This includes case sensitivity.
Send a row of Smartsheet data to a designated recipient through email.
Required fields are indicated in red.
Your Smartsheet sheets (dropdown): Select from the list of all available Smartsheet sheets associated with your Smartsheet instance. Choose Insert ID to select a Smartsheet sheet by its ID, which is entered in the Input section.
Columns to send (dropdown): Choose All Columns to send all columns, or choose Customize to choose which columns to send.
Send (dropdown): Choose Single Row if you only want to send one row within the notification. Choose List of Rows if you want to send a collection of rows in a single notification. When you select this the ID input will change to IDs and require a list of IDs in order to process correctly.
The input fields for this card are dynamically generated based on your instance.
Email
* To (text): the email address to which you want to send the update. Multiple email addresses can be specified by separating them with a comma.
* Subject (text): The subject line of the email.
* Message (text): The content of the email.
* CC Me (true/false): If true, you will be CC’d on the email.
Include
* Attachments (true/false): If true, a link to row attachments will be included in the email.
* Discussions (true/false): If true, row discussions will be included in the email.
Sheet
Rows * IDs (list): The unique ID(s) of the row(s) you want to send.
Columns
The output fields for this card are dynamically generated based on your instance.
Send an update request to another Smartsheet user. The recipient will get an email asking them to update a certain row with new information.
Based on your choices in the “Options” step, you will see a subset of the fields below.
Updates the properties associated with a column. Using this action enables you to change the name, location, and property type of a column inside of Smartsheet.
Index (text): Insert a number value to determine the index location where you would want to move the column on the sheet when it is updated. If you want the location of the column to remain unchanged leave the value blank.
Title (text): If you want to change the name of the column insert a text string into that field. To keep the value the same leave blank.
Options (text): Insert the values that you would want to update in the column property type. For example, if you are building a dropdown list you would insert the “List” output from the “Create Dropdown List” action.
Type (dropdown list): Select the property type that you would want the column to be changed to:
Transfers group ownership to the owner specified in the owner ID input field.
Update a row in a sheet.
Required fields are indicated in red.
Insert ID to select a Smartsheet sheet by its ID, which is entered in the Input section.Row * id (text): Smartsheet id of the row to update
Location * Row ID (text): If you want to update the location of the row, the ID of the row used to define the new location of the current row * Position (dropdown): The position of the current row relative to Row ID. * Do Not Move: Does not move the row * Top of Sheet: Moves the row to the top of the sheet. Row ID not required for this option, and will be ignored if provided. * Bottom of Sheet: Moves the row to the bottom of the sheet. Row ID not required for this option, and will be ignored if provided. * Above Row: Moves the row above Row ID. * Below Row: Moves the row below Row ID. * To Parent Row (Top): Makes the row a child of Row ID, putting it above all other child rows. * To Parent Row (Bottom): Makes the row a child of Row ID, putting it below all other child rows. * Indent: Keeps the row in current position, but indents it. Row ID not required for this option, and will be ignored if provided. * Outdent: Keeps the row in current position, but outdents it. Row ID not required for this option, and will be ignored if provided.
Sheet * ID (text): Smartsheet id of the sheet that contains the row to update
Columns
The output fields are dynamically generated based on your instance.
If the Restrict to checkbox at the bottom of the Insert Column or Edit Column Properties form is checked in the Smartsheet UI, you need to fill in the correct data to pass data validation.
Update multiple rows in a Smartsheet sheet.
Note: Smartsheet only allows 5000 rows per sheet.
Required fields are indicated in red.
Insert ID to select a Smartsheet sheet by its ID, which is entered in the Input section.Sheet
Update
* Rows (list): Each added row is an object. The best way to construct these objects is with a Build Row Object card, accompanied by a Construct card.
* For each row added, a build row object card is needed. Each build row object card takes a text input for each column in the associated sheet, as well as the ID of the row you’d like to edit.
* Drag the row output on each build row object card into a list construct card.
* Drag the list output from the list construct card into the rows input on the add rows card.
Updates the name of the specified sight in Smartsheet. To use this card, select which sight to update.
You’ll have an input Sight -> id that identifies the sight in Smartsheet. You will also need to include an input Name, which is the new name for the sight.
Upload an image into a specific cell. To use this card, first select which sheet to update. In the options pane, select from one of the sheets in your account, or select _–Insert ID–_ if you want to specify the ID of the sheet as in input.
If you selected one of your sheets in the previous step, then you’ll have an input Column -> id and input Row -> id that identifies which cell in the sheet. The Row -> id might come from the output of an Add Row card, or the output of a Search card. In addition, you’ll see an Upload section that requires a File Name and File Content. Both upload fields are required.
If you select the sheet as –Insert ID– then you’ll see an additional input, Sheet -> ID - this is the ID of the sheet to use, either from a previous card such as Create Sheet, or type it in (you can find the ID of a sheet in the Smartsheet application, under Properties).
This card monitors for new and updated rows in a Smartsheet report.
Metadata
Output