Jump to a Section

Overview

To get started working with the Smartsheet application, the first step is to integrate an existing Smartsheet account with Workflows. If you do not have an existing Smartsheet account and you wish to use Smartsheet with Workflows, sign up for Smartsheet first, and then return to the authorization process.

Note: You can create multiple connections and manage them from your Settings page.

To create a new connection from an Event or Action card:

  1. Click New Connection.
  2. Enter a Connection Nickname. This is useful if you plan to create multiple connections to share with your team.
  3. Click Create.
  4. In the authorization dialog, enter the email address that is associated with your Smartsheet account.
  5. Click Allow to authorize access to your Smartsheet account.
  • Smartsheet

    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.

Events

  • New Row - Webhook

    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.

    Options

    • Your Smartsheet sheets (dropdown): Select from the list of all available Smartsheet sheets associated with your Smartsheet instance.

    Output Fields

    • Row
      • The fields in this section are dynamically generated based on the columns available in the selected sheet. Fields are assigned according to the names of the columns within the sheet.
    • Metadata
      • id (text): the row id within Smartsheet
      • rowNumber (text): the row number within the sheet
      • createdAt (text): the time that a new row was created
      • modifiedAt (text): the time that a new row was modified at
  • Row Updated - Webhook

    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.

    Options

    • Your Smartsheet sheets (dropdown): Select from the list of all available Smartsheet sheets associated with your Smartsheet instance.
    • Trigger on sort? (dropdown): Choose from Yes or No.

    Output Fields

    • Row
      • The fields in this section are dynamically generated based on the columns available in the selected sheet. Fields are assigned according to the names of the columns within the sheet.
    • Metadata
      • id (text): the row id within Smartsheet
      • rowNumber (text): the row number within the sheet
      • createdAt (text): the time that a new row was created
      • modifiedAt (text): the time that a new row was modified at

Actions

  • Add Row

    Create a new row in a Smartsheet sheet.

    Note: Smartsheet only allows 5000 rows per sheet.

    Required fields are indicated in red.

    Options

    • 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.
    • Row Position (dropdown)
      • Top of Sheet: Adds the row at the top of the sheet
      • Bottom of Sheet: Adds the row at the bottom of the sheet
      • Above Row: Adds the row above a row that you specify
      • Below Row: Adds the row below a row that you specify
      • To Parent Row (top): Adds the row as the top child row to a parent row that you specify
      • To Parent Row (bottom): Adds the row as the bottom child to a parent row that you specify

    Input

    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

    Output

    Row * id (text): The Smartsheet ID for the created row. * rowNumber (text): The number assigned to the newly created row.

  • Add Rows

    Create multiple new rows in a Smartsheet sheet.

    Note: Smartsheet only allows 5000 rows per sheet.

    Required fields are indicated in red.

    Options

    • 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.
    • Row Position (dropdown)
      • Top of Sheet: Adds the row at the top of the sheet
      • Bottom of Sheet: Adds the row at the bottom of the sheet
      • Above Row: Adds the row above a row that you specify
      • Below Row: Adds the row below a row that you specify
      • To Parent Row (top): Adds the row as the top child row to a parent row that you specify
      • To Parent Row (bottom): Adds the row as the bottom child to a parent row that you specify

    Input

    The input fields for this card are dynamically generated based on your instance.

    Sheet * ID (text): Unique identifier of the sheet

    Add

    • 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.
      • 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.

    Location * Row ID (text): Unique identifier of the row

    Output

    • Row IDs (list): The list of row IDs for each created Smartsheet row
  • Build Row Object

    Use with ‘Add Rows’ or ‘Update Rows’ to create or update more than one row in a sheet.

    Options

    • Your Smartsheet sheets (dropdown list): a list of all available Smartsheet sheets associated with your Smartsheet account.
    • Action (dropdown list):
      • Add Rows - The created object will be used for Add Rows card
      • Update Rows - The created object will be used for Update Rows card

    Input Fields

    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.

    Output Fields

    • Row (object): your newly-built row, which can be dragged and dropped into ‘Add Rows’ or ‘Update Rows’.
  • Comment on Row

    Comment on Row

    Add a comment to a row in a Smartsheet sheet.

    Required fields are indicated in red.

    Options

    • 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.

    Input

    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.

    Output

    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.

  • Copy Row

    Copy a row between sheets.

    Note: Smartsheet only allows 5000 rows per sheet.

    Required fields are indicated in red.

    Input

    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

    Output

    Result * Copied Row ID (text): ID of the new row that was created as a result of the action

  • Custom API Action

    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.

    Options

    Request Type (dropdown): The type of request you’d like to make. See Squarespace HTTP Requests. * GET * POST * PUT * PATCH * DELETE

    Input

    Request

    • Relative URL (text): Specify the relative URL as /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.

      Example: https://api.smartsheet.com/2.0{{input.Request.Relative URL}}

    • Query (object): Specify any additional query parameters that should be included in object format (key value pairs).

    • Headers (object): Specify any headers required in addition to authorization or content-type (these are already handled by this connector).

    • Body (object): Specify a request body in JSON format.

    Output

    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"}
    • Body (object): data returned from your selected HTTP request (for example, the data from a GET request).
  • Delete Rows

    Delete multiple rows in a Smartsheet sheet.

    Required fields are indicated in red.

    Options

    • 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.

    Input Fields

    Sheet * ID (text): Unique identifier of the sheet

    Delete

    • Row IDs (text): The list of row IDs of the rows you’d like to delete. Can add multiple row IDs.
  • Move Row

    Move a row between sheets.

    Note: Smartsheet only allows 5000 rows per sheet.

    Required fields are indicated in red.

    Input

    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

    Output

    Result * Moved Row ID (text): ID of the new row that was created as a result of the action

  • Read Row

    Read the values of a row in Smartsheet using the row ID.

    Required fields are indicated in red.

    Options

    • 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.

    Input

    Sheet * ID (text): Unique identifier of the sheet you want to use.

    Row * ID (text): The ID of the row you wish to read.

    Output

    Columns The output fields are dynamically generated based on your instance.

  • Read Row by Number

    Read the values of a row in Smartsheet using the row number.

    Options

    Required fields are indicated in red.

    Options

    • 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.

    Input

    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.

    Output

    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.

  • Send Row

    Send a row of Smartsheet data to a designated recipient through email.

    Required fields are indicated in red.

    Options

    • 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.

    Input

    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

    • ID (text): The ID of the 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.

  • Update Row

    Update Row

    Update a row in a sheet.

    Required fields are indicated in red.

    Options

    • 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.

    Input

    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 Rows

    Update multiple rows in a Smartsheet sheet. 

    Note: Smartsheet only allows 5000 rows per sheet.

    Required fields are indicated in red.

    Options

    • 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.

    Input

    Sheet

    • Sheet ID (text): Unique identifier of the 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.