Skip to main content

Smartsheet Component

Interact with the Smartsheet API

Component key: smartsheet

Description#

Smartsheet is a software as a service offering for collaboration and work management, developed and marketed by Smartsheet Inc. This component allows you to manage and interact with a Smartsheet file.

Smartsheet Connections#

Smartsheet Connection#

Information about getting started and creating API keys with Smartsheet can be found on their developer documentation site.

InputNotes
Input
API Key
string
/ Required
Notes
Provide a string value for the API Key.

Triggers#

Webhook#

Trigger for handling webhooks from Smartsheet | key: webhook

You can configure a Smartsheet webhook to send information to a Prismatic webhook URL under certain conditions (a "Column" is updated, a "Row" is deleted, etc.).

For more information on configuring webhooks refer to the Microsoft Graph API Docs

Additionally, you can reference a trigger's results.webhookUrls to create a webhook in a deploy-triggered flow. That'll configure webhooks to point to an instance when that instance is deployed to a customer.

Output Example Payload#

{  "payload": {    "headers": {      "accept": "*/*",      "Content-Type": "application/json",      "User-Agent": "Apache-HttpClient/4.5.1 (Java/11.0.12)",      "Host": "hooks.example.prismatic.io"    },    "body": {      "data": {        "webhookId": "example098093842",        "challenge": "example32482-237762-234"      }    },    "rawBody": {      "data": { "type": "Buffer", "data": [69, 120, 97, 109, 112, 108, 101] }    },    "queryParameters": {},    "webhookUrls": {      "Flow 1": "https://hooks.example.prismatic.io/trigger/EXAMPLEGbG93Q29uZmlnOmRlNmNmNDMyLTliNWMtN0005NDMxLTRmYzA4ZjViODgxOA=="    },    "webhookApiKeys": { "Flow 1": ["abc-123"] },    "customer": {      "externalId": "customer-example-external-id",      "name": "John Doe"    }  }}

Actions#

Add/Update Row#

Adds or Updates a Row on the specified Sheet | key: upsertRow

InputNotesExample
Input
Column Values
string
Key Value List
Notes
A list of columns to be updated with the specified value
Example
Task Name: My Todo
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Log Level
string
Notes
Provide a string value for log level
Example
 
Input
Sheet ID
string
/ Required
Notes
Provide a string value for the Sheet ID
Example
6830028284938
Input
Row Identifier
string
Notes
An identifier used to find a Row for Update
Example
 

Copy Rows#

Copies multiple rows from the sheet specified in the action to (the bottom of) another sheet. | key: copyRows

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Log Level
string
Notes
Provide a string value for log level
Example
 
Input
Row ID
string
/ Required
Value List
Notes
For each list item, provide a value for the Row ID of the row you would like to copy.
Example
6830028284938
Input
Sheet ID
string
/ Required
Notes
Provide a string value for the Sheet ID
Example
6830028284938
Input
Copy To Sheet ID
string
/ Required
Notes
Provide a string value for the Sheet ID of the sheet you would like to insert the copied values into
Example
6830028284938

Create Webhook#

Create a new webhook | key: createWebhook

InputDefaultNotesExample
Input
CallbackURL
string
/ Required
Default
 
Notes
Provide a valid URL that represents your callback URL. To set up a smartsheet trigger, enter your trigger URL here.
Example
https://hooks.prismatic.io/EXAMPLE
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Object Id Of Scope
string
/ Required
Default
 
Notes
Provide the unique identifier of the scope object you provided.
Example
sheet_3285357287499652
Input
Subscope
code
Default
{ columnIds: [7318427511613316, 7318427511613123] }
Notes
Provide a JavaScript Object with a list property 'columnIds' This enables your webhook to capture activity in a specific column of your sheet.
Example
*.*
Input
Events
string
/ Required
Value List
Default
 
Notes
For each item, provide an event you would like to watch.
Example
*.*
Input
Webhook Name
string
/ Required
Default
 
Notes
Provide a string value for the name of the webhook.
Example
MyExampleWebhook
Input
Scope
string
/ Required
Default
 
Notes
Provide a string value for the scope of the webhook.
Example
sheet

Delete Column#

Delete a column on the specified Sheet | key: deleteColumn

InputNotesExample
Input
Column Title
string
/ Required
Notes
Provide a value for the title of the column.
Example
Due Date
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Log Level
string
Notes
Provide a string value for log level
Example
 
Input
Sheet ID
string
/ Required
Notes
Provide a string value for the Sheet ID
Example
6830028284938

Delete Row#

Deletes a row on the specified Sheet | key: deleteRow

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Log Level
string
Notes
Provide a string value for log level
Example
 
Input
Row Identifier
string
/ Required
Notes
An identifier used to find a Row
Example
 
Input
Sheet ID
string
/ Required
Notes
Provide a string value for the Sheet ID
Example
6830028284938

Get Column#

Lists the Columns in the specified Sheet | key: getColumn

InputNotesExample
Input
Column Title
string
/ Required
Notes
Provide a value for the title of the column.
Example
Due Date
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Log Level
string
Notes
Provide a string value for log level
Example
 
Input
Sheet ID
string
/ Required
Notes
Provide a string value for the Sheet ID
Example
6830028284938

Get Row#

Get all the cells and their values in a given row | key: getRow

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Log Level
string
Notes
Provide a string value for log level
Example
 
Input
Row Identifier
string
/ Required
Notes
An identifier used to find a Row
Example
 
Input
Sheet ID
string
/ Required
Notes
Provide a string value for the Sheet ID
Example
6830028284938

Get Sheet#

Get the information and metadata of a sheet by ID | key: getSheet

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Log Level
string
Notes
Provide a string value for log level
Example
 
Input
Sheet ID
string
/ Required
Notes
Provide a string value for the Sheet ID
Example
6830028284938

List Columns#

Lists the Columns in the specified Sheet | key: listColumns

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Log Level
string
Notes
Provide a string value for log level
Example
 
Input
Sheet ID
string
/ Required
Notes
Provide a string value for the Sheet ID
Example
6830028284938

List Sheets#

Lists sheets in a project. | key: listSheets

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Log Level
string
Notes
Provide a string value for log level

Search All#

Searches for the specified text in all Sheets the user can access. | key: searchAll

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Log Level
string
Notes
Provide a string value for log level
Example
 
Input
Search Text
string
/ Required
Notes
A string of text used to search a sheet.
Example
Any Text

Search Sheet#

Searches for the specified text in a Sheet. | key: searchSheet

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Log Level
string
Notes
Provide a string value for log level
Example
 
Input
Search Text
string
/ Required
Notes
A string of text used to search a sheet.
Example
Any Text
Input
Sheet ID
string
/ Required
Notes
Provide a string value for the Sheet ID
Example
6830028284938

Synchronous Search#

Searches a Sheet for specified text (may perform worse that SearchSheet depending on dataset) | key: syncSearch

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Log Level
string
Notes
Provide a string value for log level
Example
 
Input
Search Text
string
/ Required
Notes
A string of text used to search a sheet.
Example
Any Text
Input
Sheet ID
string
/ Required
Notes
Provide a string value for the Sheet ID
Example
6830028284938